Developer Setup¶

Install the local source code using pip

pip install -e .

Unit tests¶

You can run unit tests with tox:

tox

To build the documentation pages available as Markdown files under ./docs:

pip install -r requirements-docs.txt
mkdocs serve

The documentation will be available at http://localhost:8000.

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 install

The 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.