Development#

To run the tests, you will need pytest, pytest-cov and chex. They can be installed with the dev option:

poetry install --with dev

And the tests can be run with:

poetry run pytest ./test

Linting#

To lint the code, you will need ruff, pyright and mypy. They can also be installed with the dev option. Usage:

poetry run ruff check
poetry run ruff format --check
poetry run pyright .
poetry run mypy .

To build the documentation, you will need sphinx. It is included in the dev option. The documentation can be built with:

poetry run make -C docs html

With sphinx-autobuild, you can also build the documentation and serve it locally with:

poetry run make -C docs serve