Development#

This project is built and published using uv. To setup a development environment for this project you can follow these steps:

  1. Install uv.

  2. Navigate to the root folder and install the project’s virtual environment:

uv sync

  1. You should now have .venv directory created containing the project’s virtual environment files. You can optionally activate the environment subshell by running:

source .venv/bin/activate

  1. To deactivate the environment subshell, run:

deactivate

  1. Format the code by running the command:

uv run ruff format

  1. Check the code linting by running the command:

uv run ruff check

  1. Run the unit tests by running the command:

uv run pytest

  1. To export the documentation dependency requirements, run the following:

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

This Page