Developer Setup
Install the local source code using pip
pip install -e .Documentation
To build the documentation pages available as Asciidoc files under ./docs:
npm install make antora
The documentation will be available at file:///path/to/the/repo/public/index.html.
Linting
We use pre-commit to automatically format the Python source code of this project.
To be efficient, you should run pre-commit before committing (hence the name…).
To do that, run once :
pip install pre-commit
pre-commit installThe linting workflow will now run on modified files before committing, and will fix issues for you.
If you want to run the full workflow on all the files: pre-commit run -a.