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
  • Claude Code skills (e.g. project orientation)
  • MCP server configuration (mcp.json)
  • Design-doc templates (architecture.md, requirements.md)

Requirements

  • Python >= 3.12
  • uv (for uvx), or install with pip install dev-ready
  • 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

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
  --no-skills \           # skip the Claude Code skills overlay
  --no-mcp \              # skip the MCP configuration overlay
  --no-docs               # skip the design-doc templates

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.1.2.tar.gz (53.2 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.1.2-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dev_ready-0.1.2.tar.gz
Algorithm Hash digest
SHA256 fc9f0e342f3cb97919c403a7d5281c06e33015b40d7a4cf7a454788016316890
MD5 2efde6d6d6c83ff41f40ebec2bfc3975
BLAKE2b-256 7b9f5a86e4b157bbdc6c69d207c97b24d20febf88445f5c3f209c86af8736e5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for dev_ready-0.1.2.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.1.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for dev_ready-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1802e4efae8a962163f3440d6757c14b987873432a81330d7869b3fcd9674c11
MD5 3f8050b142aaeb50f8d96614de5b38f6
BLAKE2b-256 e2654f65476cdbef1bd328150d19622c418bda64f2674c63263f1d4294f0e1e3

See more details on using hashes here.

Provenance

The following attestation bundles were made for dev_ready-0.1.2-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