Merge branch 'release/1.1.0'

Makefile

@@ -79,23 +79,23 @@ clean: ## Clean the project directory
 	find . -name '*~' -exec rm -f {} +
 
 .PHONY: docs
-docs:
+docs: ## build docs
 	rm -f docs/source/pit.rst
 	rm -f docs/source/modules.rst
 	sphinx-apidoc -o docs/source provit
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 
-.PHONY: dist
-dist: 	clean 
+.PHONY: dist 
+dist: 	clean build-frontend ## Clean repo, build fronend, sdist and bdist
 	python setup.py sdist bdist_wheel
 
 .PHONY: testupload
-testupload: dist
+testupload: dist ## Upload release to PyPI Test
 	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 
 .PHONY: release
-release: dist
+release: dist ## Upload release to PyPI
 	twine upload dist/*
 
 

README.rst

@@ -4,9 +4,11 @@ provit - Provenance Integration Tools
 |Python 3| |GitHub license| |GitHub issues| |Docs passing|
 
 *provit* is a data provenance annotation and documentation tool. It provides various feature for
-creation and retrieval of provenance information for file like stored data. Tracking sources, 
-modification, and merges allows the user to keep track of data provenance in long running 
-workflows (e.g. for a scientific thesis).
+creation and retrieval of provenance information for data stored in files. The tracking of sources, 
+modifications and merges allows the user to keep a log of all modifications a dataset was subject
+to. This is especially useful for dataset which are accessed intermittently or part of a long 
+running workflow (e.g. for a scientific thesis). Furthermore, provenance data stored next to the 
+data in an archive can help others to identify quality, value and acutality of the data. 
 
 *provit* does not require any external infrastructure. All information is stored in *.prov* 
 files right next to the data files as a JSON-LD graph. This makes it the perfect tool for small 
@@ -26,46 +28,29 @@ Full documentation is available under: `provit.readthedocs.io <https://provit.re
 
 .. image:: assets/provit_promo.png
 
-Installation
-------------
+Quick Installation
+------------------
 
-Installation via `pip <https://pypi.org/>`__ is recommended for end
-users. We strongly encourage end users to make use of a
-`virtualenv <https://virtualenv.pypa.io/en/stable/>`__.
+.. note::
+   *provit* requires a working installation of Python 3.7, furthermore the use of a 
+   `virtualenv <https://virtualenv.pypa.io/en/stable/>`__ is strongly encouraged.
+   If you need help to set this up, please follow the Installation section in the documentation. 
 
-pip
-~~~
-
-Clone the repository and create a virtual environment (optional) and 
-install into with pip into the virtualenv.
+*provit* is availabe via the Python Package Index (PyPI) and can be installed by using
+pip `pip <https://pypi.org/>`__. Simply create a virtualenvironment with your 
+preferred method a run the *pip install* command:
 
 .. code:: zsh
 
     $ mkvirtualenv provit
     $ pip install provit
 
-git / Development
-~~~~~~~~~~~~~~~~~
-
-Clone the repository and create a virtualenv.
-
-.. code:: zsh
-
-    $ git clone https://github.com/diggr/provit
-    $ mkvirtualenv provit
-
-Install it with pip (*editable*).
-
-.. code:: zsh
-
-    $ pip install -e provit
-
 Quickstart
 ----------
 
 *provit* provides three modes of interaction:
 
-* command line interface
+* command line interface 
 * graphical user interface 
 * python package
 
@@ -81,7 +66,6 @@ You can start provit browser directly from your terminal:
 
     $ provit browser
 
-
 provit cli
 ~~~~~~~~~~
 
@@ -139,7 +123,7 @@ Overview
 :License: MIT
 :Copyright: 2018-2019, Peter Mühleder and `Universitätsbibliothek Leipzig <https://ub.uni-leipzig.de>`__
 
-.. |Python 3| image:: https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7-blue.svg
+.. |Python 3| image:: https://img.shields.io/badge/python-3.7-blue.svg
 .. |GitHub license| image:: https://img.shields.io/github/license/diggr/pit.svg
    :target: https://github.com/diggr/pit/blob/master/LICENSE
 .. |GitHub issues| image:: https://img.shields.io/github/issues/diggr/pit.svg

docs/source/_static/assets

@@ -0,0 +1 @@
+../../../assets

docs/source/command_line_interface.rst

@@ -1,10 +1,60 @@
 provit command line interface
 =============================
 
-Provenance information can be added using the command line interface.
+Provenance information can be inspected and created using the command line interface.
+A short demonstration of the capabilities is given below.
 
-To do that, *cd* to your data directory and invoke the *provit* cli on any data file
-you like.
+.. image:: assets/provit_demo_001.gif
+
+Show Provenance
+---------------
+
+To show the provenance information for a file *cd* into the directory and enter the show 
+command.
+
+.. code:: zsh
+
+        $ provit show source_file
+        {
+            "uri": "http://vocab.ub.uni-leipzig.de/provit/source_file/0cab498f56e3417da1120dcaa6f48354",
+            "agent": [
+                "http://vocab.ub.uni-leipzig.de/provit/enrich_0.1.0"
+            ],
+            "activity": "http://vocab.ub.uni-leipzig.de/provit/data_download/632c7e1fb1814cda86d7c727f1b1a4ed",
+            "ended_at": "2019-11-27 15:01:48",
+            "activity_desc": "The data was downloaded",
+            "location": "/home/fraemisch/tmp/provit_demo/source_file",
+            "primary_sources": [
+                "http://vocab.ub.uni-leipzig.de/provit/https:/diggr.link"
+            ],
+            "sources": []
+        }
+
+
+Create Provenance (interactively)
+---------------------------------
+
+Provenance information can be appended to existing provenance information or 
+created for files, which do not yet have provenance information attached.
+
+The following command will take you to the interactive prompt which guides you through 
+the provenance creation process.
+
+.. code:: zsh
+        
+        $ provit create FILENAME
+
+.. note::
+
+        Agents can not be created properly using this interface. Please see :doc:`vocabulary` for 
+        information on the types of agents and how to create them.
+
+
+Create Provenance (non-interactive)
+-----------------------------------
+
+Sometimes you want to create provenance by just giving the information as command line 
+arguments. This is also possible, but should only be used by advanced users or in scripts.
 
 .. code:: zsh
 

docs/source/conf.py

@@ -81,7 +81,18 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'default'
+# html_theme = 'default'
+html_theme = 'alabaster'
+
+html_theme_options = {
+    "font_family": '"Avenir Next", Calibri, "PT Sans", sans-serif',
+    "head_font_family": '"Avenir Next", Calibri, "PT Sans", sans-serif',
+    "font_size": "14px",
+    "page_width": "980px",
+    "sidebar_width": "225px",
+    "logo": "assets/provit.png",
+    "show_relbars": True
+}
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/source/index.rst

@@ -6,14 +6,14 @@
 Welcome to provit!
 ==================
 
-.. image:: assets/provit_promo.png
-
 This is the documentation for the provenance integration tools (provit).
 It consinsts of a command line interface, a browser frontend and a python
 package which you can include into your project to track your provenance
 from within your software. Feel free to look around and contact us, if 
 you have any questions or find mistakes.
 
+.. image:: assets/provit_demo_001.gif
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: