Skip to content

Setting Up Your Development Environment

Install uv

This package uses uv to manage dependencies and the virtual environment for development. Please consult the uv documentation and make sure you have uv installed to be able to contribute.

Create the venv

Run the following commands in your terminal to ensure your virtual environment is correctly setup:

uv venv -p 3.11
source .venv/bin/activate
uv pip install -r pyproject.toml --all-extras
uv pip install -e .
uv lock

Adding dependencies

To add packages as main dependencies, you can run uv add <package>.

To add packages as optional dependencies, you can run uv add --optional <group> <package>, for example:

  • To add local development dependencies, you can run:

    uv add --optional dev <package>
    

  • To add test dependencies, you can run:

    uv add --optional test <package>