Skip to content

Commit

Permalink
resolved merge conflict in setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
missinglinks committed Mar 1, 2019
2 parents 2f39843 + f4ac92c commit 40059f7
Show file tree
Hide file tree
Showing 56 changed files with 1,411 additions and 761 deletions.
1 change: 1 addition & 0 deletions .gitignore
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ main.py
.idea
pit/test
.pytest_cache
test_pit.py


build/
Expand Down
Empty file modified LICENSE
100644 → 100755
Empty file.
4 changes: 3 additions & 1 deletion MANIFEST.in
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
include LICENSE

include pit/provis/templates/*.html
include provit/browser/templates/*.html
include provit/browser/static/js/*.js
include provit/browser/static/css/*.css

recursive-exclude * __pycache__
recursive-exclude * *.py[co]
Expand Down
Empty file modified Makefile
100644 → 100755
Empty file.
45 changes: 26 additions & 19 deletions README.rst
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,22 @@ P(ROV)IT - PROVenance integration tools
|Python 3.6| |GitHub license| |GitHub issues| |Docs passing|

PROVIT is a light, dezentralized provenance tracking framework. It allows
the user to track workflows and modifications of data and files. A
small subset of the `W3C <https://www.w3.org/>`__ `PROV-O
vocabulary <https://www.w3.org/TR/prov-o/>`__ is implemented. Its aim is to
provided an easy to use interface for users who have never worked with provenance
the user to track workflows and modifications of data and files.

ROVIT works completely decentralized, all information is stored in .prov
files (as JSON-LD RDF graphs) along it's corresponding data file in the file system.
No central database or server setup is needed.

Asmall subset of the `W3C <https://www.w3.org/>`__ `PROV-O
vocabulary <https://www.w3.org/TR/prov-o/>`__ is implemented.

Its aim is to provided an easy to use interface for users who have never worked with provenance
tracking before. It you feel limited by PROVIT you should have a look at
the more extensive implementation `prov <https://github.com/trungdong/prov/>`__.

Full documentation is available under: `provit.readthedocs.io <https://provit.readthedocs.io/en/latest/>`__.


Requirements
------------

Expand Down Expand Up @@ -58,44 +65,49 @@ Usage
Provenance Integration Tools provide a command line client which can be
used *out of the box* to enrich any file based data with provenance
information. Furthermore the provenance class and vocabulary shipped
with *PIT* can be used within other applications.
with *provit* can be used within other applications.

Command Line Client
~~~~~~~~~~~~~~~~~~~

Usage:

Open provit Browser:

.. code:: zsh
$ provit browser
Add provenace event to a file:

.. code:: zsh
$ pit [OPTIONS] FILEPATH
$ pit add FILEPATH [OPTIONS]
Options:

--add Add provenance information layer to file
-a AGENT, --agent AGENT Provenance information: agent
--activity ACTIVITY Provenance information: activity
-d DESCRIPTION, --desc DESCRIPTION Provenance information: Description
of the data manipulation process
-o ORIGIN, --origin ORIGIN Provenance information: Data origin
-s SOURCES, --sources SOURCES Provenance information: Source files
-b, --browser Provenance browser
-n NAMESPACE, --namespace NAMESPACE Provenance Namespace, default: http://provit.diggr.link/
--help Show this message and exit.

Provenance Class
~~~~~~~~~~~~~~~~

.. code:: python
from pit.prov import Provenance
from provit import Provenance
# load prov data for a file, or create new prov for file
prov = Provenance(<filepath>)
# add provenance metadata
prov.add(agent="agent", activity="activity", description="...")
prov.add_primary_source("primary_source", url="http://...", comment="...")
prov.add_sources(["filepath1", "filepath2"])
prov.add(agents=[ "agent" ], activity="activity", description="...")
prov.add_primary_source("primary_source")
prov.add_sources([ "filepath1", "filepath2" ])
# return provenance as json tree
prov_dict = prov.tree()
Expand Down Expand Up @@ -141,12 +153,7 @@ FAQ / Paradigms
Can I add multiple agents to an activity?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

No. The reason is: If you can distinguish the activities or impact of
the agent, then you have multiple agents with *multiple activities*.
E.g. if you let three students help you proofreading a file and you get
back *1* revised version, then the three students are *1 agent* as you
cannot distinguish between their results. If you get back *3 versions*
you have *3 agents* and *3 activities*.
Yes.

Overview
--------
Expand Down
Empty file modified assets/provit.svg
100644 → 100755
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/Makefile
100644 → 100755
Empty file.
Empty file modified docs/modules.rst
100644 → 100755
Empty file.
Empty file modified docs/source/conf.py
100644 → 100755
Empty file.
Empty file modified docs/source/index.rst
100644 → 100755
Empty file.
Empty file modified docs/source/modules.rst
100644 → 100755
Empty file.
Empty file modified docs/source/pit.provis.rst
100644 → 100755
Empty file.
Empty file modified docs/source/pit.rst
100644 → 100755
Empty file.
Empty file modified docs/source/readme.rst
100644 → 100755
Empty file.
Empty file removed pit/__init__.py
Empty file.
53 changes: 0 additions & 53 deletions pit/check.py

This file was deleted.

32 changes: 0 additions & 32 deletions pit/config.py

This file was deleted.

0 comments on commit 40059f7

Please sign in to comment.