Skip to main content

Development

Development Guidelines

Installing uv

Dependencies and admin actions are done using uv. To Install uv follow the guidelines in https://docs.astral.sh/uv/getting-started/installation/, it is recommended to use the standalone installation.

Building Project

To sync the dependencies and create a local env that fits the requirements, simply run:

make install

This will install both requirements and necessary development dependencies, such as dev and docs dependency groups. To build the wheels:

make build

Running tests

To run all the tests with associated coverage:

make test

Running scripts

For running scripts or one-offs using the project's installed enviroment The build the associated wheels simply run:

uv build

To sync the dependencies simply run:

uv sync

Running scripts

For running scripts or one using the project's environment:

uv run python <script>