atdd 0.7.10

ATDD Platform - Acceptance Test Driven Development toolkit

ATDD

Acceptance Test Driven Development toolkit for structured planning and convention enforcement.

ATDD covers the full software lifecycle, not just code. It starts from a job to be done (e.g., user problem or goal), turns it into deterministic requirements, validates them with tests, and then drives implementation.

flowchart LR
    A[Job to be Done] -->|Planner| B[Wagon + Acceptance Criteria]
    B -->|Tester| C[RED Tests]
    C -->|Coder| D[GREEN Code]

Installation

From PyPI

pip install atdd

Upgrade

pip install --upgrade atdd

For Development

# Clone the repo
git clone https://github.com/afokapu/atdd.git
cd atdd

# Install in editable mode with dev dependencies
pip install -e ".[dev]"

# Verify installation
atdd --help

Quick Start

atdd init                      # Initialize ATDD in your project
atdd gate                      # ⚠️ START EVERY SESSION WITH THIS
atdd session new <task>        # Create a planning session
atdd sync                      # Sync rules to agent config files
atdd validate                  # Run all validators

⚠️ atdd gate is required. 🤖 Tell your agent: "Run atdd gate and follow ATDD rigorously." Agents skip instruction files but can't ignore tool ou

tput. No gate = no ATDD guarantees.

What It Does

ATDD provides:

1. Session Management - Structured planning documents with templates and tracking
2. Convention Enforcement - YAML-based conventions validated via pytest
3. ATDD Lifecycle - Planner → Tester → Coder phase gates
4. Agent Config Sync - Keep ATDD rules in sync across AI agent config files

flowchart LR
    A[Job to be Done] -->|Planner| B[Wagon + Acceptance Criteria]
    B -->|Tester| C[RED Tests]
    C -->|Coder| D[GREEN Code]
    D -->|Coder| E[REFACTOR]
    E -.->|feedback| B

    subgraph "ATDD Lifecycle"
        B
        C
        D
        E
    end

Commands

Project Initialization

atdd init              # Create atdd-sessions/, .atdd/, and CLAUDE.md
atdd init --force      # Reinitialize (overwrites existing)

Creates:

your-project/
├── CLAUDE.md              # With managed ATDD block
├── atdd-sessions/
│   ├── SESSION-TEMPLATE.md
│   └── archive/
└── .atdd/
    ├── manifest.yaml      # Session tracking
    └── config.yaml        # Agent sync configuration

Session Management

atdd session new <slug>                 # Create new session
atdd session new <slug> --type <type>   # Specify type
atdd session list                       # List all sessions
atdd session archive <id>               # Archive session
atdd session sync                       # Sync manifest with files

Session types: implementation, migration, refactor, analysis, planning, cleanup, tracking

Agent Config Sync

Sync ATDD rules to agent config files using managed blocks that preserve user content:

atdd sync                  # Sync all enabled agents from config
atdd sync --agent claude   # Sync specific agent only
atdd sync --verify         # Check if files are in sync (for CI)
atdd sync --status         # Show sync status for all agents

Supported agents:

Agent	File
claude	CLAUDE.md
codex	AGENTS.md
gemini	GEMINI.md
qwen	QWEN.md

Configure which agents to sync in .atdd/config.yaml:

version: "1.0"
sync:
  agents:
    - claude      # Enabled by default
    # - codex     # Uncomment to sync AGENTS.md
    # - gemini    # Uncomment to sync GEMINI.md
    # - qwen      # Uncomment to sync QWEN.md

Multi-agent setup: To use multiple agents with consistent rules, enable them all in config and run sync:

sync:
  agents:
    - claude
    - codex
    - gemini
    - qwen

atdd sync  # Creates/updates CLAUDE.md, AGENTS.md, GEMINI.md, QWEN.md

ATDD Gate (Bootstrap Protocol)

Agents often skip instruction files. The gate solves this by injecting rules via mandatory tool output.

Protocol:

1. Run this command first:

   atdd gate
   

2. Agent must paste output and confirm:

   • Which file(s) were loaded
   • The reported hash
   • The key constraints

3. If files are missing/unsynced:

   atdd sync
   atdd gate  # Re-verify
   

Example output:

============================================================
ATDD Gate Verification
============================================================

Loaded files:
  - CLAUDE.md (hash: d04f897c6691dc13...)

Key constraints:
  1. No ad-hoc tests - follow ATDD conventions
  2. Domain layer NEVER imports from other layers
  3. Phase transitions require quality gates

------------------------------------------------------------
Before starting work, confirm you have loaded these rules.
------------------------------------------------------------

Why this works:

• Gate output is mandatory tool output - agent can't ignore it
• Proves which ATDD files were actually loaded
• Forces consistency across all agents

Rule: If ATDD rules matter, start with atdd gate. No gate = no guarantees.

Validation

atdd validate              # Run all validators
atdd validate planner      # Planning validators only
atdd validate tester       # Testing validators only
atdd validate coder        # Implementation validators only
atdd validate --quick      # Fast smoke test
atdd validate --coverage   # With coverage report
atdd validate --html       # With HTML report

Release Versioning

ATDD enforces release versioning via coach validators. Recommended: keep a single root VERSION file as the canonical source (first line like 1.2.3 - short summary; trailing summary is ignored). Configure the version file and tag prefix in .atdd/config.yaml:

release:
  version_file: "VERSION"  # recommended single source of truth
  tag_prefix: "v"

If you also publish with language-specific manifests (e.g., pyproject.toml, package.json), keep their version fields in sync with VERSION.

Validation (atdd validate coach or atdd validate) requires:

• Version file exists and contains a version
• Git tag on HEAD matches {tag_prefix}{version}

Other Commands

atdd status                    # Platform status
atdd inventory                 # Generate artifact inventory
atdd inventory --format json   # Inventory as JSON
atdd registry update           # Update all registries
atdd --help                    # Full help

Project Structure

src/atdd/
├── cli.py                 # Entry point
├── coach/
│   ├── commands/          # CLI command implementations
│   ├── conventions/       # Coach conventions (YAML)
│   ├── overlays/          # Agent-specific additions
│   ├── schemas/           # JSON schemas
│   ├── templates/         # Session templates, ATDD.md
│   └── validators/        # Coach validators
├── planner/
│   ├── conventions/       # Planning conventions
│   ├── schemas/           # Planning schemas
│   └── validators/        # Planning validators
├── tester/
│   ├── conventions/       # Testing conventions
│   ├── schemas/           # Testing schemas
│   └── validators/        # Testing validators
└── coder/
    ├── conventions/       # Coding conventions
    ├── schemas/           # Coder schemas
    └── validators/        # Implementation validators

Development

Setup

git clone https://github.com/afokapu/atdd.git
cd atdd
pip install -e ".[dev]"

Run Tests

# All tests
pytest

# Specific phase
pytest src/atdd/planner/validators/

# With coverage
pytest --cov=atdd --cov-report=html

Adding Validators

1. Create src/atdd/{phase}/validators/test_{name}.py
2. Write pytest test functions
3. Run atdd validate {phase}

Validators are auto-discovered by pytest.

Adding Conventions

1. Create src/atdd/{phase}/conventions/{name}.convention.yaml
2. Reference in validators via Path(__file__).parent.parent / "conventions" / "..."

Requirements

• Python 3.10+
• pyyaml

Dev dependencies: pytest, pytest-xdist

License

MIT