Contribution Guidelines

Setup your development environment

The project uses uv for development. It needs to be installed to set up the development environment.

curl -LsSf https://astral.sh/uv/install.sh | sh

Once uv is installed, a Python virtual environment can be quickly bootstrapped by running the following commands in the root of the repository.

uv venv
source .venv/bin/activate

This will create a virtual environment in .venv directory and activate it.

Next, install all dependencies using the following command

uv sync

To run the CLI (or any command) under the context of the virtual environment, prepend the commands with uv run

uv run rio --help

New dependencies can be installed directly using uv. This modifies the pyproject.toml and uv.lock.

uv add <package-name>

You can check and fix the code style by running the following commands.

uvx ruff check --fix
uvx ruff format