Development

[dbrattli]

This project is now managed using Poetry. Code is formatted using Black, and isort. Code is statically type checked using pyright and mypy. Every PR will be checked that they comply with the code checks using pre-commit, so it's better to check locally before submitting a PR, or you will end up doing many small commits to fix things. Follow the instructions below to make the development experience simpler.

This may initially feel too strict, adding unnecessary friction but it makes the code look the same for everyone, and by pointing these issues out before the code review, this allows the maintainers to focus on the architecture of a change while not wasting time with trivial style nitpicks.

If you want to take advantage of the default VSCode integration, then first configure Poetry to make its virtual environment in the repository:

poetry config virtualenvs.in-project true

After cloning the repository, activate the tooling:

poetry install
poetry run pre-commit install

Run unit tests:

poetry run pytest

Run code checks (manually):

poetry run pre-commit run --all-files