fastapp-cli

FastAPI 项目脚手架：一条命令生成完整、可直接运行的 FastAPI 工程。

fastapp create my-server

特性

• 分层架构：api / schemas / crud / services / models 分层，内置泛型 CRUD / Service 基类
• 开箱即用的工程能力：统一响应 / 异常体系、TraceID 中间件、loguru 日志、pydantic-settings 多环境配置
• 分页 CRUD + 过滤：基于 fastapi-pagination 与 fastapi-filter 的完整示例（/api/v1/items）
• Celery 可选：--celery 启用时生成完整任务骨架（默认 redis broker，本地无 redis 时启动自动降级 memory:// 并告警）；默认不启用
• Alembic 迁移：接入 SQLModel.metadata，含 autogenerate 过滤钩子
• 优雅降级：MySQL 缺席不阻塞启动，/api/v1/health 返回 database: up/down
• 工程化配套：Makefile、scripts/、pre-commit、ruff + mypy + pytest 配置全套
• 可选部署文件：--pm2 / --docker 按需生成（pm2.config.js，celery 未启用时对应启动命令自动注释）
• AI Agent 友好：生成项目自带 docs/agent_guide.md 开发参考文档（架构、核心方法清单、扩展流程）

安装

# uv tool（推荐）
uv tool install fastapp-cli

# 或 pipx
pipx install fastapp-cli

# 或一次性使用
uvx fastapp create demo

使用

fastapp create <project_name> [options]

全部关键项通过 flag 提供时零交互：

fastapp create my-server --description "demo" --no-pm2 --no-docker --no-celery

生成完成后：

cd my-server && uv sync
make dev        # 访问 /api/v1/docs

生成项目依赖

fastapi、sqlmodel、alembic、fastapi-pagination、fastapi-filter、loguru、pydantic-settings 等，dev 组含 pytest / ruff / mypy / pre-commit；--celery 启用时额外引入 celery[redis] 与 flower。

开发 fastapp-cli 自身

uv sync --group dev
uv run pytest          # 单元 + 冒烟测试
uv run ruff check .

发布

uv build     # 构建 sdist + wheel（模板随包发布）
uv publish   # 发布到 PyPI

版本策略：v0.1.0 起，语义化版本。