Install tdp lib for dev:
poetry install # Installs dependencies and the package in venv
poetry run pre-commit install --hook-type pre-commit
poetry run pre-commit install --hook-type commit-msg
Install optional dependencies for graph visualization:
sudo apt install graphviz
poetry install -E visualization
Run the tests:
poetry run pytest tdp
Format the code:
poetry run black .
Documentation can be found inside:
- docs for documentation index
- docs/cli for CLI documentation index
- docs/Developer Quick Start
To generate the documentation:
poetry install -E docs
poetry run task docs-html