Skip to main content

Development Environment Setup

This page is for contributors working on rtl_buddy. For the published package, see Installation.

Prerequisites​

  • Python 3.11 or later.
  • uv.
  • git.

uv manages the environment from pyproject.toml and uv.lock. External EDA tools are required only for their matching commands; see Installation.

Clone And Sync​

git clone https://github.com/rtl-buddy/rtl_buddy.git
cd rtl_buddy
uv sync --group dev

This installs the package and the lint, test, and docs groups. Add --extra graph-extract only when working on the optional graph binding tier.

Verify the install:

uv run rb --version

Pre-Commit Hook​

Install the Ruff pre-commit hook once:

uv tool install pre-commit
pre-commit install

Lint And Format​

uv run ruff check
uv run ruff format --check
uv run ruff format          # rewrite files

Tests​

uv run pytest                                # full suite
uv run pytest tests/test_cli_with_fixture.py # one file
uv run pytest -k "list"                      # by keyword
uv run pytest --cov --cov-report=term-missing

Coverage is opt-in; plain pytest stays fast.

Docs​

uv run python scripts/check_docs_frontmatter.py --check
npm ci
npm run build
npm run start

npm run start previews the Docusaurus site at http://localhost:3000/.

The build also writes llms.txt, llms-full.txt, a JSON page catalog, raw Markdown pages, and section-level Markdown under build/agent/. These static resources mirror rb docs for networked agents; the CLI remains the offline, installed-version interface.

npm run build:all also rebuilds every published major from that major's latest stable Git tag. CI runs it on pull requests and for stable release deployment after the new tag exists. It refreshes dev from the latest origin/main snapshot and stable versions from their tags.

For CLI help changes, regenerate the reference before building:

uv run python scripts/gen_cli_reference.py

Do not edit docs/reference/cli.md by hand. See Documentation Guidelines.

Building Wheels And Sdists​

uv build
uv build --wheel
uv build --sdist

Artifacts land in dist/. Inspect wheel and sdist contents when changing [tool.hatch.build.targets.*]; both must include the package and docs, not tests or development configuration.

Validating Against The Project Template​

For end-user behavior changes, use the template's local-development worktree. Point its editable rtl_buddy source at the exact feature worktree being tested.

# In a sibling clone of rtl-buddy-project-template:
git worktree add .worktrees/dev-local dev/local-rtl-buddy
cd .worktrees/dev-local
uv sync
uv run rb regression -c regression.yaml

Follow the template's AGENTS.md. Keep dev/local-rtl-buddy local and do not merge it to main.

Authoring Rules​