Skip to content

Development setup

This guide describes a minimal local setup for working on Crader.

Requirements

  • Python 3.10+
  • git
  • Optional: PostgreSQL with pgvector (required for e2e tests)

Setup

git clone https://github.com/filippodaminato/crader.git
cd crader

python -m venv .venv
source .venv/bin/activate

pip install -e ".[dev]"

Tests

Unit and integration tests are mostly mocked and do not require a database:

pytest tests/unit/ tests/integration/

End-to-end tests require PostgreSQL and a runnable git environment:

pytest tests/e2e/

Linting and type checks

ruff check src tests
mypy src

Local PostgreSQL (optional)

A Docker Compose file is available for the debugger stack:

docker compose -f tools/debugger/docker-compose.yml up -d