Installation

django-prov is tested on Python 3.12 and depends on the libraries Django and prov

You can install it with the following command:

git clone https://github.com/DLR-SC/django-prov.git
cd django-prov/
pip install -e .

Important

If you want to generate graphical output like SVG or PNG files, you also need to have graphviz installed:

apt install -y graphviz graphviz-dev

Development installation

If you want to contribute to django-prov, you can clone it and install it with development and testing options:

git clone https://github.com/DLR-SC/django-prov.git
cd django-prov/
pip install -e ".[develop, test]"

You can execute the tests using the following command:

mkdir -p build
pytest --cov --cov-report=term --cov-report=html --cov-report=xml --junitxml=build/test-report.xml tests/

You can build the documentation with sphinx using the following command:

mkdir -p build/
sphinx-build -b html docs/ build/docs/

You can run the example app using the following command:

python -m example/manage.py runserver

For changing the provenance recording options, please have a look at the options described in Configuring the ProvenanceGenerator