Contribute

This project was developed using the poetry packagin tool. First, you'll need to install poetry via instructions on that site.

Installing development dependencies

poetry install

Running the tests

From the project root, run

poetry run pytest tests/

Building the documentation

To start up a live reloading documentation server

poetry run mkdocs serve