comparison env/lib/python3.9/site-packages/prov-1.5.1.dist-info/DESCRIPTION.rst @ 0:4f3585e2f14b draft default tip

"planemo upload commit 60cee0fc7c0cda8592644e1aad72851dec82c959"
author shellac
date Mon, 22 Mar 2021 18:12:50 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4f3585e2f14b
1 ============
2 Introduction
3 ============
4
5
6 .. image:: https://badge.fury.io/py/prov.svg
7 :target: http://badge.fury.io/py/prov
8 :alt: Latest Release
9 .. image:: https://travis-ci.org/trungdong/prov.svg
10 :target: https://travis-ci.org/trungdong/prov
11 :alt: Build Status
12 .. image:: https://img.shields.io/coveralls/trungdong/prov.svg
13 :target: https://coveralls.io/r/trungdong/prov?branch=master
14 :alt: Coverage Status
15 .. image:: https://landscape.io/github/trungdong/prov/master/landscape.svg?style=flat
16 :target: https://landscape.io/github/trungdong/prov/master
17 :alt: Code Health
18 .. image:: https://img.shields.io/pypi/wheel/prov.svg
19 :target: https://pypi.python.org/pypi/prov/
20 :alt: Wheel Status
21 .. image:: https://img.shields.io/pypi/pyversions/prov.svg
22 :target: https://pypi.python.org/pypi/prov/
23 :alt: Supported Python version
24 .. image:: https://img.shields.io/pypi/l/prov.svg
25 :target: https://pypi.python.org/pypi/prov/
26 :alt: License
27
28
29 A library for W3C Provenance Data Model supporting PROV-O (RDF), PROV-XML, PROV-JSON import/export
30
31 * Free software: MIT license
32 * Documentation: http://prov.readthedocs.io/.
33
34 Features
35 --------
36
37 * An implementation of the `W3C PROV Data Model <http://www.w3.org/TR/prov-dm/>`_ in Python.
38 * In-memory classes for PROV assertions, which can then be output as `PROV-N <http://www.w3.org/TR/prov-n/>`_
39 * Serialization and deserializtion support: `PROV-O <http://www.w3.org/TR/prov-o/>`_ (RDF), `PROV-XML <http://www.w3.org/TR/prov-xml/>`_ and `PROV-JSON <http://www.w3.org/Submission/prov-json/>`_.
40 * Exporting PROV documents into various graphical formats (e.g. PDF, PNG, SVG).
41 * Convert a PROV document to a `Networkx MultiDiGraph <http://networkx.github.io/documentation/latest/reference/classes.multidigraph.html>`_ and back.
42
43
44 Uses
45 ^^^^
46
47 See `a short tutorial <http://trungdong.github.io/prov-python-short-tutorial.html>`_ for using this package.
48
49 This package is used extensively by `ProvStore <https://provenance.ecs.soton.ac.uk/store/>`_,
50 a free online repository for provenance documents.
51
52
53
54
55 History
56 -------
57
58 1.5.1 (2017-07-18)
59 ^^^^^^^^^^^^^^^^^^
60 * Replaced pydotplus with pydot (see #111)
61 * Fixed datetime and bundle error in RDF serialisation
62 * Tested against Python 3.6
63 * Improved documentation
64
65 1.5.0 (2016-10-19)
66 ^^^^^^^^^^^^^^^^^^
67 * Added: Support for `PROV-O <http://www.w3.org/TR/prov-o/>`_ (RDF) serialization and deserialization
68 * Added: `direction` option for :py:meth:`prov.dot.prov_to_dot`
69 * Added: :py:meth:`prov.graph.graph_to_prov` to convert a `MultiDiGraph <https://networkx.readthedocs.io/en/stable/reference/classes.multigraph.html>`_ back to a :py:class:`~prov.model.ProvDocument`
70 * Testing with Python 3.5
71 * Various minor bug fixes and improvements
72
73 1.4.0 (2015-08-13)
74 ^^^^^^^^^^^^^^^^^^
75 * Changed the type of qualified names to prov:QUALIFIED_NAME (fixed #68)
76 * Removed XSDQName class and stopped supporting parsing xsd:QName as qualified names
77 * Replaced pydot dependency with pydotplus
78 * Removed support for Python 2.6
79 * Various minor bug fixes and improvements
80
81 1.3.2 (2015-06-17)
82 ^^^^^^^^^^^^^^^^^^
83 * Added: prov-compare script to check equivalence of two PROV files (currently supporting JSON and XML)
84 * Fixed: deserialising Python 3's bytes objects (issue #67)
85
86 1.3.1 (2015-02-27)
87 ^^^^^^^^^^^^^^^^^^
88 * Fixed unicode issue with deserialising text contents
89 * Set the correct version requirement for six
90 * Fixed format selection in prov-convert script
91
92 1.3.0 (2015-02-03)
93 ^^^^^^^^^^^^^^^^^^
94 * Python 3.3 and 3.4 supported
95 * Updated prov-convert script to support XML output
96 * Added missing test JSON and XML files in distributions
97
98
99 1.2.0 (2014-12-19)
100 ^^^^^^^^^^^^^^^^^^
101 * Added: :py:meth:`prov.graph.prov_to_graph` to convert a :py:class:`~prov.model.ProvDocument` to a `MultiDiGraph <https://networkx.readthedocs.io/en/stable/reference/classes.multigraph.html>`_
102 * Added: PROV-N serializer
103 * Fixed: None values for empty formal attributes in PROV-N output (issue #60)
104 * Fixed: PROV-N representation for xsd:dateTime (issue #58)
105 * Fixed: Unintended merging of Identifier and QualifiedName values
106 * Fixed: Cloning the records when creating a new document from them
107 * Fixed: incorrect SoftwareAgent records in XML serialization
108
109 1.1.0 (2014-08-21)
110 ^^^^^^^^^^^^^^^^^^
111 * Added: Support for `PROV-XML <http://www.w3.org/TR/prov-xml/>`_ serialization and deserialization
112 * A :py:class:`~prov.model.ProvRecord` instance can now be used as the value of an attributes
113 * Added: convenient assertions methods for :py:class:`~prov.model.ProvEntity`, :py:class:`~prov.model.ProvActivity`, and :py:class:`~prov.model.ProvAgent`
114 * Added: :py:meth:`prov.model.ProvDocument.update` and :py:meth:`prov.model.ProvBundle.update`
115 * Fixed: Handling default namespaces of bundles when flattened
116
117 1.0.1 (2014-08-18)
118 ^^^^^^^^^^^^^^^^^^
119 * Added: Default namespace inheritance for bundles
120 * Fixed: :py:meth:`prov.model.NamespaceManager.valid_qualified_name` did not support :py:class:`~prov.model.XSDQName`
121 * Added: Convenience :py:func:`prov.read` method with a lazy format detection
122 * Added: Convenience :py:meth:`~prov.model.ProvBundle.plot` method on the :py:class:`~prov.model.ProvBundle` class (requiring matplotlib).
123 * Changed: The previous :py:meth:`!add_record` method renamed to :py:meth:`~prov.model.ProvBundle.new_record`
124 * Added: :py:meth:`~prov.model.ProvBundle.add_record` function which takes one argument, a :py:class:`~prov.model.ProvRecord`, has been added
125 * Fixed: Document flattening (see :py:meth:`~prov.model.ProvDocument.flattened`)
126 * Added: :py:meth:`~prov.model.ProvRecord.__hash__` function added to :py:class:`~prov.model.ProvRecord` (**at risk**: to be removed as :py:class:`~prov.model.ProvRecord` is expected to be mutable)
127 * Added: :py:attr:`~prov.model.ProvRecord.extra_attributes` added to mirror existing :py:attr:`~prov.model.ProvRecord.formal_attributes`
128
129 1.0.0 (2014-07-15)
130 ^^^^^^^^^^^^^^^^^^
131
132 * The underlying data model has been rewritten and is **incompatible** with pre-1.0 versions.
133 * References to PROV elements (i.e. entities, activities, agents) in relation records are now QualifiedName instances.
134 * A document or bundle can have multiple records with the same identifier.
135 * PROV-JSON serializer and deserializer are now separated from the data model.
136 * Many tests added, including round-trip PROV-JSON encoding/decoding.
137 * For changes pre-1.0, see CHANGES.txt.
138
139