Skip to main content

Scaffold AI-development-ready FastAPI projects: pinned upstream template plus Claude Code skills, MCP config, and design docs

Project description

dev-ready

Scaffold a production-grade, AI-development-ready FastAPI + React project in one command:

uvx dev-ready init my-app

The upstream template is pinned to a CI-verified commit (never an untested "latest"), and generation is all-or-nothing — if any step fails, your target directory is never touched.

What you get

A generated project based on fastapi/full-stack-fastapi-template (FastAPI, React, SQLModel, PostgreSQL, Docker Compose), plus an AI tooling overlay so it works well with coding agents out of the box:

  • CLAUDE.md — project instructions for Claude Code, including Karpathy-derived development guardrails (MIT, per the upstream README)
  • Claude Code skills — nine pre-configured skills selectable at generation time:
    • project-orientation (built-in) — codebase orientation helper
    • react-doctor (pinned devDependency) — frontend dependency health checks
    • caveman (vendored, MIT) — token-discipline communication mode
    • tdd (vendored, MIT) — test-driven development loop
    • diagnosing-bugs (vendored, MIT) — diagnosis loop for hard bugs
    • code-review (vendored, MIT) — review against coding standards and spec
    • security-audit (vendored, MIT) — multi-phase security audit
    • webapp-testing (vendored, Apache-2.0) — browser-automation end-to-end testing
    • frontend-design (vendored, Apache-2.0) — frontend UI design methodology
  • MCP server configuration (mcp.json)
  • Design-doc templates (architecture.md, requirements.md)
  • Agent-team handoff scaffold (docs/handoffs/ — a document-driven multi-agent workflow: Tech Lead → Senior → Junior → QA/Security/SRE)
  • Generation stamp — every generated project gets a .dev-ready.json recording the dev-ready version, selected components/items, and pinned upstream commit
  • Pinned tool integrations — optional, selectable MCP and skill items: a codebase-memory MCP server (uvx codebase-memory-mcp) and a react-doctor frontend wrapper skill + devDependency
  • Item-level selection — pick individual skills (including vendored ones) and MCP items; vendored skills include their upstream provenance in .dev-ready.json

Every generated project also gets its own README.md (the upstream template's repo README and other repo-maintenance files — CONTRIBUTING.md, release notes, deploy workflows, screenshots — are pruned, so nothing template-repo-specific leaks into your project).

Requirements

  • Python >= 3.12 (uv can install this for you automatically)
  • git (Copier fetches the pinned template via git)
  • Network access to github.com (to fetch the pinned template snapshot)
  • Docker is not required to generate a project — only to run the generated one

Installation

No install needed with uv (any recent version):

uvx dev-ready init my-app

Or install with pip (requires Python >= 3.12):

pip install dev-ready
dev-ready init my-app

Usage

# Interactive: prompts for anything not given on the command line
uvx dev-ready init

# Non-interactive: accept all defaults, no prompts
uvx dev-ready init my-app --yes

# Options
uvx dev-ready init my-app \
  --dir path/to/target \    # default: ./my-app
  --skills <ids|all|none> \ # choose individual skills (default: all)
  --mcp <ids|all|none> \    # choose individual MCP servers (default: all)
  --no-skills \             # skip the Claude Code skills overlay
  --no-mcp \                # skip the MCP configuration overlay
  --no-docs \               # skip the design-doc templates
  --no-agents               # skip the agent-team handoff scaffold

Then follow the printed next steps (typically docker compose watch inside the generated project).

Exit codes: 0 success; 1 unexpected error or user abort; 2 argument error; 3 network/fetch failure; 4 target directory conflict; 5 structural verification failure.

How it works

The CLI ships with a lockfile (manifest.json) pinning the upstream template commit. Generation fetches that exact snapshot, applies the overlay with variable substitution, verifies the result structurally — all inside a staging directory — and only then moves it into the target. The pin is kept current by a weekly CI job that opens bump PRs, each validated by actually generating and booting a project with Docker Compose.

Links

License

MIT. Generated projects include content derived from fastapi/full-stack-fastapi-template (MIT); see THIRD_PARTY_NOTICES.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dev_ready-0.5.0.tar.gz (225.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dev_ready-0.5.0-py3-none-any.whl (137.9 kB view details)

Uploaded Python 3

File details

Details for the file dev_ready-0.5.0.tar.gz.

File metadata

  • Download URL: dev_ready-0.5.0.tar.gz
  • Upload date:
  • Size: 225.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for dev_ready-0.5.0.tar.gz
Algorithm Hash digest
SHA256 e6ee36457d54164cda7daf137673aabd9d9711cb4423b3d96124171bec2e0928
MD5 135a7c1297a968d70b6237049c026dc6
BLAKE2b-256 ce2396fa41c6df9d3a835158fe29c925148b2869278634811e8734dc8613b540

See more details on using hashes here.

Provenance

The following attestation bundles were made for dev_ready-0.5.0.tar.gz:

Publisher: release.yml on MoofonLi/dev-ready

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dev_ready-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: dev_ready-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 137.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for dev_ready-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0c803b562082767bd7111e988406d125d3c6199cab0f7136af9e4a4c85ad046b
MD5 b9ef6a981f72132e4dfc1e32e4b27341
BLAKE2b-256 90257ae4129f096622e23c977bb6dab890b74d2d3942ff713684399c6948bee4

See more details on using hashes here.

Provenance

The following attestation bundles were made for dev_ready-0.5.0-py3-none-any.whl:

Publisher: release.yml on MoofonLi/dev-ready

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page