Getting Started

Before contributing to the SDK, read the main CONTRIBUTING.md at the root of the repository. It contains guidelines that apply to all contributors, including commit conventions and the pull request workflow.

Before you start

Install uv for Python environment management.

Development setup

git clone https://github.com/rhesis-ai/rhesis.git
cd rhesis/sdk

# Create a development virtual environment
uv sync --dev

# Activate the virtual environment
source .venv/bin/activate

Linting and formatting

From sdk:

make format      # auto-format and fix all Python files
make lint        # check formatting without modifying files

Both targets use ruff  via uvx. There are also diff-scoped variants that only run against files changed relative to main:

make format_diff
make lint_diff

Tests

Tests live in ../tests/sdk (relative to sdk/), not inside the SDK package itself.

From sdk:

• Unit tests — make test runs pytest on ../tests/sdk, ignoring ../tests/sdk/integration.
• Integration tests — make test-integration starts the sdk Docker profile (see tests/docker-compose.test.yml), then runs the full suite including ../tests/sdk/integration.
• Coverage — make test-coverage runs pytest with coverage reporting for src/rhesis.
• Teardown — make docker-down (or make docker-clean to remove volumes).

Run a single test after starting the Docker profile yourself:

make docker-up
uv run pytest -s ../tests/sdk/entities/test_endpoint.py::test_endpoint -v

Questions or need help?

• Contact us at support@rhesis.ai
• Create an issue in the repository
• Check our documentation