Development¶

This section provides information for developers who want to contribute to the project.

Setting Up the Development Environment¶

You can use uv to set up a virtual environment for development.

uv sync --dev

To run the test suite, use the following command:

uv run pytest tests/

The documentation is built using MkDocs with the Material theme.

To build the documentation, execute the following command:

uv run mkdocs build

Or to get live updates while editing the documentation:

uv run mkdocs serve

This will start a development server at http://127.0.0.1:8000 with automatic reload when you make changes to the documentation files.

Dependencies need to be exported to a requirements.txt file in order to be accessible to Read The Docs.

uv export --no-hashes --format requirements-txt  --group documentation > docs/requirements.txt