Development#

Development environment#

This package uses poetry, instantiate everything by

poetry install --all-extras

in order to update dependencies, do changes in pyproject.toml and run

poetry lock --no-update
poetry install --all-extras

You can run the formatting by

poetry run poe format-code

which uses Poe task to format the whole project using ruff.

This package uses mypy, you can run it by

poetry run mypy . --config-file pyproject.toml

To run the tests, you can use the following command:

poetry run pytest

this runs static analysis, linter and tests.

Make sure the documentation is correct by

poetry run mkdocs serve