Development¶

Project conventions, contributor docs, and architecture decision records (ADRs) for the Agent Assembly Python SDK. Start here when contributing code or operating a release.

Contributor docs¶

Page	What it covers
CONTRIBUTING.md	Dev environment setup, framework adapter authoring, test/lint commands, branch naming, PR checklist.
Architecture	Internals: the adapter/patch layers, the PyO3 FFI layer, and the exact `init_assembly()` bootstrap/teardown order.
Compatibility & Versioning	Supported Python versions, core-runtime tracking, and the release process.
Troubleshooting	Common integration errors, what they mean, and how to fix them.

Architecture decision records¶

ADRs capture the why behind major design choices so future maintainers can trace the reasoning.

ADR-0001 — Hook architecture — why Python owns monkey-patching while Rust owns IPC transport.

Quick command reference¶

uv sync                       # install deps + dev extras
uv run pytest                 # run the test suite
uv run pytest -m integration  # integration tests only
uv run ruff check .           # lint
uv run mypy agent_assembly    # type-check

See CONTRIBUTING.md for the full workflow.