fastapp-cli 0.1.0__py3-none-any.whl

fastapp_cli/templates/project/scripts/celery_worker.sh.j2

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+# 启动 Celery Worker
+set -euo pipefail
+
+cd "$(dirname "$0")/.."
+
+CONCURRENCY="${CONCURRENCY:-4}"
+QUEUE="${QUEUE:-default}"
+LOG_LEVEL="${LOG_LEVEL:-INFO}"
+
+exec uv run celery -A app.core.celery_app.celery_app worker \
+    -Q "${QUEUE}" \
+    -c "${CONCURRENCY}" \
+    -l "${LOG_LEVEL}" \
+    -n "worker@%h"

fastapp_cli/templates/project/scripts/start.sh.j2

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+# 启动 FastAPI 服务
+set -euo pipefail
+
+cd "$(dirname "$0")/.."
+
+HOST="${HOST:-0.0.0.0}"
+PORT="${PORT:-8000}"
+WORKERS="${WORKERS:-1}"
+
+if [ "${APP_ENV:-development}" = "production" ]; then
+    echo "[prod] launching uvicorn with ${WORKERS} workers"
+    exec uv run uvicorn app.main:app --host "${HOST}" --port "${PORT}" --workers "${WORKERS}"
+else
+    echo "[dev] launching uvicorn with reload"
+    exec uv run uvicorn app.main:app --host "${HOST}" --port "${PORT}" --reload
+fi

fastapp_cli/templates/project/tests/api/test_health.py.j2

@@ -0,0 +1,15 @@
+"""Health 接口测试."""
+
+from __future__ import annotations
+
+from fastapi.testclient import TestClient
+
+
+def test_health(client: TestClient) -> None:
+    """健康检查返回应用状态与数据库状态."""
+    resp = client.get("/api/v1/health")
+    assert resp.status_code == 200
+    body = resp.json()
+    assert body["status"] == "ok"
+    assert body["database"] in ("up", "down")
+    assert "trace_id" not in body or body.get("trace_id") is None

fastapp_cli/templates/project/tests/api/test_items.py.j2

@@ -0,0 +1,61 @@
+"""Items 接口集成测试（分页 CRUD + 过滤）."""
+
+from __future__ import annotations
+
+from fastapi.testclient import TestClient
+
+
+def test_item_crud_roundtrip(client: TestClient) -> None:
+    """创建 -> 查询 -> 更新 -> 删除 -> 404 全链路."""
+    # 创建（非生产环境认证占位自动通过）
+    resp = client.post(
+        "/api/v1/items",
+        json={"title": "hello", "description": "world", "price": 9.9},
+    )
+    assert resp.status_code == 200, resp.text
+    body = resp.json()
+    assert body["code"] == 0
+    assert body["data"]["title"] == "hello"
+    assert body["trace_id"]
+    item_id = body["data"]["id"]
+
+    # 列表（分页）
+    resp = client.get("/api/v1/items")
+    assert resp.status_code == 200
+    data = resp.json()["data"]
+    assert data["total"] >= 1
+    assert any(it["id"] == item_id for it in data["content"])
+
+    # 过滤
+    resp = client.get("/api/v1/items", params={"title": "hel"})
+    assert resp.status_code == 200
+    assert all("hel" in it["title"] for it in resp.json()["data"]["content"])
+
+    # 详情
+    resp = client.get(f"/api/v1/items/{item_id}")
+    assert resp.status_code == 200
+    assert resp.json()["data"]["id"] == item_id
+
+    # 更新
+    resp = client.patch(f"/api/v1/items/{item_id}", json={"title": "updated"})
+    assert resp.status_code == 200
+    assert resp.json()["data"]["title"] == "updated"
+    assert resp.json()["data"]["description"] == "world"  # 未传字段不受影响
+
+    # 删除
+    resp = client.delete(f"/api/v1/items/{item_id}")
+    assert resp.status_code == 200
+
+    # 再次查询 404
+    resp = client.get(f"/api/v1/items/{item_id}")
+    assert resp.status_code == 404
+    assert resp.json()["code"] == 40400
+
+
+def test_get_missing_item_returns_404(client: TestClient) -> None:
+    """查询不存在的 Item 返回统一 404 结构."""
+    resp = client.get("/api/v1/items/999999")
+    assert resp.status_code == 404
+    body = resp.json()
+    assert body["code"] == 40400
+    assert body["message"] == "资源不存在"

fastapp_cli/templates/project/tests/conftest.py.j2

@@ -0,0 +1,61 @@
+"""Pytest fixtures & 测试配置."""
+
+from __future__ import annotations
+
+import os
+
+# 强制切换到测试环境，需要在 app 模块导入前设置
+os.environ.setdefault("APP_ENV", "test")
+os.environ.setdefault("DATABASE_URI", "sqlite:///:memory:")
+os.environ.setdefault("CELERY_BROKER_URL", "memory://")
+os.environ.setdefault("CELERY_RESULT_BACKEND", "cache+memory://")
+
+from collections.abc import Generator
+
+import pytest
+from fastapi.testclient import TestClient
+from sqlalchemy.pool import StaticPool
+from sqlmodel import Session, SQLModel, create_engine
+
+from app.core.database import get_session
+from app.main import app
+
+
+@pytest.fixture(scope="session")
+def engine():
+    """每个测试 session 共享一个内存 SQLite 引擎."""
+    test_engine = create_engine(
+        "sqlite://",
+        connect_args={"check_same_thread": False},
+        poolclass=StaticPool,
+    )
+    SQLModel.metadata.create_all(test_engine)
+    yield test_engine
+    SQLModel.metadata.drop_all(test_engine)
+
+
+@pytest.fixture
+def db_session(engine) -> Generator[Session, None, None]:
+    """每个测试提供独立的 Session，结束后回滚保证数据隔离."""
+    connection = engine.connect()
+    transaction = connection.begin()
+    session = Session(bind=connection)
+
+    yield session
+
+    session.close()
+    transaction.rollback()
+    connection.close()
+
+
+@pytest.fixture
+def client(db_session: Session) -> Generator[TestClient, None, None]:
+    """FastAPI 测试客户端，注入测试会话."""
+
+    def _override_get_session() -> Generator[Session, None, None]:
+        yield db_session
+
+    app.dependency_overrides[get_session] = _override_get_session
+    with TestClient(app) as test_client:
+        yield test_client
+    app.dependency_overrides.clear()

fastapp_cli/templates/project/tests/services/test_item_service.py.j2

@@ -0,0 +1,44 @@
+"""ItemService 单元测试（sqlite 内存库）."""
+
+from __future__ import annotations
+
+from sqlmodel import Session
+
+from app.crud.item import CRUDItem
+from app.models.item import Item
+from app.schemas.item import ItemCreate, ItemUpdate
+from app.services.item_service import ItemService
+
+
+def test_service_create_get_update_delete(db_session: Session) -> None:
+    """Service 层增删改查全链路."""
+    service = ItemService(db_session, CRUDItem(Item))
+
+    # 创建
+    created = service.create(ItemCreate(title="t1", description="d1", price=1.5))
+    assert created.id is not None
+    assert created.title == "t1"
+
+    # 获取
+    fetched = service.get(created.id)
+    assert fetched.id == created.id
+
+    # 更新（exclude_unset 语义）
+    updated = service.update(created.id, ItemUpdate(title="t2"))
+    assert updated.title == "t2"
+    assert updated.description == "d1"
+
+    # 删除
+    deleted = service.delete(created.id)
+    assert deleted.id == created.id
+
+
+def test_service_get_missing_raises(db_session: Session) -> None:
+    """获取不存在的记录抛出 NotFoundError（404 语义）."""
+    import pytest
+
+    from app.core.exceptions import NotFoundError
+
+    service = ItemService(db_session, CRUDItem(Item))
+    with pytest.raises(NotFoundError):
+        service.get(999999)

fastapp_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.5
+Name: fastapp-cli
+Version: 0.1.0
+Summary: FastAPI 项目脚手架：一条命令生成完整可运行的 FastAPI 工程
+Author: aidenmo
+License: MIT
+Keywords: cli,fastapi,scaffold,sqlmodel,template
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.10
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: typer>=0.12.0
+Description-Content-Type: text/markdown
+
+# fastapp-cli
+
+FastAPI 项目脚手架：一条命令生成**完整、可直接运行**的 FastAPI 工程。
+
+```bash
+fastapp create my-server
+```
+
+## 特性
+
+- **分层架构**：`api / schemas / crud / services / models` 分层，内置泛型 CRUD / Service 基类
+- **开箱即用的工程能力**：统一响应 / 异常体系、TraceID 中间件、loguru 日志、pydantic-settings 多环境配置
+- **分页 CRUD + 过滤**：基于 fastapi-pagination 与 fastapi-filter 的完整示例（`/api/v1/items`）
+- **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` 按需生成
+
+## 安装
+
+```bash
+# uv tool（推荐）
+uv tool install fastapp-cli
+
+# 或 pipx
+pipx install fastapp-cli
+
+# 或一次性使用
+uvx fastapp create demo
+```
+
+## 使用
+
+```bash
+fastapp create <project_name> [options]
+```
+
+| 参数 | 默认 | 说明 |
+|---|---|---|
+| `project_name` | 必填 | 项目名；小写字母/数字/连字符，如 `my-server` |
+| `--description` | 交互提问 | 项目描述 |
+| `--pm2 / --no-pm2` | 交互提问 | 是否生成 `pm2.config.json` |
+| `--docker / --no-docker` | 交互提问 | 是否生成 `Dockerfile` |
+| `--python` | `3.12` | 目标 Python 版本（写入 `.python-version`） |
+| `--author` | `git config user.name` | 作者署名 |
+| `--force` | 关 | 目标目录已存在时覆盖重建 |
+| `--no-git` | 关 | 跳过 `git init` |
+
+全部关键项通过 flag 提供时零交互：
+
+```bash
+fastapp create my-server --description "demo" --no-pm2 --no-docker
+```
+
+生成完成后：
+
+```bash
+cd my-server && uv sync
+make dev        # 访问 /api/v1/docs
+```
+
+## 生成项目依赖
+
+fastapi、sqlmodel、alembic、celery[redis]、fastapi-pagination、fastapi-filter、loguru、pydantic-settings 等，dev 组含 pytest / ruff / mypy / pre-commit。
+
+## 开发 fastapp-cli 自身
+
+```bash
+uv sync --group dev
+uv run pytest          # 单元 + 冒烟测试
+uv run ruff check .
+```
+
+## 发布
+
+```bash
+uv build     # 构建 sdist + wheel（模板随包发布）
+uv publish   # 发布到 PyPI
+```
+
+版本策略：v0.1.0 起，语义化版本。

fastapp_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,67 @@
+fastapp_cli/__init__.py,sha256=qFCT_E_SW3FQo1M8JsfHpFZ8N9uzPBZvAwKEwxfLmOs,67
+fastapp_cli/create.py,sha256=73uzI0rzE-aOtEqU-cOyqnTNqdNtDMyn4pzAbMEeQrU,4780
+fastapp_cli/main.py,sha256=esejW58f6yQWRB-Guo4tA_-DMy2hheeaUobKay_Z8ps,572
+fastapp_cli/naming.py,sha256=hqf5Zp7UPbLfTshkBzqmdfs4l3BK13OWPLAM6PRizgI,1256
+fastapp_cli/prompts.py,sha256=Q_NPpJpNWeY7yt7iR4vp6fN2FxsKiiI_i9DpLVZyYRQ,1021
+fastapp_cli/render.py,sha256=nGINL23Cj01wXZHLSX_jX6Psn8ifnHIpZtGHobL3Weg,4552
+fastapp_cli/templates/__init__.py,sha256=zhjzr92oq_fzKzAIz3pvBBBdlosqDTIZSKv3aoSmAk4,35
+fastapp_cli/templates/project/.env.development.example.j2,sha256=NInJETzOsXXU2eGVKc0i6lhNu9mXBrzJ4JUKlk7P5AY,493
+fastapp_cli/templates/project/.env.example.j2,sha256=j6mzuST_BkRBZndroXu23QGa0IoeWH9qe0Ru_erQywc,763
+fastapp_cli/templates/project/.env.j2,sha256=7ugrW889G-wjYrR5As45FktyhDwLykgiR3qfLuEBxOM,773
+fastapp_cli/templates/project/.gitignore,sha256=V1ZXTBYK__a3sPmb4OkVpEGI9xRc6_hi2nXBoUgRcq0,3364
+fastapp_cli/templates/project/.pre-commit-config.yaml.j2,sha256=CN152QtO6CXHPHNQdkPUuDOb9Epn2ASHoks1fofOAj4,2676
+fastapp_cli/templates/project/.python-version.j2,sha256=qmjmizmsXLw7uI3xvWI-IYz8E_WZeAlZPJZ6gzaNtjs,21
+fastapp_cli/templates/project/Dockerfile.j2,sha256=k8pc57spoMaOqYUiBMD6Q_JX2-Lz3I2HgqW9Ni-kEQE,424
+fastapp_cli/templates/project/Makefile.j2,sha256=XfEwUoWMU2eRBGKn4D0t9AFYbB9YLwt6kk2gwVldjfY,595
+fastapp_cli/templates/project/README.md.j2,sha256=bOp7vFJ8o3I87fhn7Ra6aanP4qeMR6uDdr9UPDS1hn4,2689
+fastapp_cli/templates/project/alembic.ini.j2,sha256=AlnCAgT-Km5EDrBkWKF5QXjwWjZ2PPy2KN1B3O3Rpyg,948
+fastapp_cli/templates/project/pm2.config.json.j2,sha256=YUXTHi2hI3lE2c66XBuNeOVBbuT83qtUqRZGVZC39ts,1101
+fastapp_cli/templates/project/pyproject.toml.j2,sha256=U2XiDOq-bnkuS27KxOiDpCYtAoq1cOE2cZh-YopLR24,6391
+fastapp_cli/templates/project/alembic/env.py.j2,sha256=FD6sYlQSRCur7pMPUN_zmgHlS8qbGityKMVE80dHSlU,2641
+fastapp_cli/templates/project/alembic/script.py.mako,sha256=Z9nr1bIwmfCe6qX_XQSJJUB1RNSxcGOX-7qi3B83IMY,687
+fastapp_cli/templates/project/alembic/versions/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapp_cli/templates/project/app/__init__.py.j2,sha256=HOYtpxjqEGAS2_c_rmbopvOS5qy6FRI_J4pAiSYOuDU,10
+fastapp_cli/templates/project/app/main.py.j2,sha256=miI0v6SHhhnL0olyae2bdkT5_rZN1ZYBM_YZN_ie1nc,3736
+fastapp_cli/templates/project/app/api/__init__.py.j2,sha256=VHtktKr-UQmKf8Yx1LA64J08b_Ga4P40vL_k0540wro,17
+fastapp_cli/templates/project/app/api/deps.py.j2,sha256=JOeAQM4DQMmLKtPON5av_TL2hXBIASQfvuSUo5JrGzM,1102
+fastapp_cli/templates/project/app/api/v1/__init__.py.j2,sha256=x24359gFTf_2ne3iDo2viPo5mCdopg2PrQBYpkYsiX0,23
+fastapp_cli/templates/project/app/api/v1/router.py.j2,sha256=BPjdyDjpQDVHBfW0mUDvA83bxV7qSbphwvr9-Nlexcs,274
+fastapp_cli/templates/project/app/api/v1/endpoints/__init__.py.j2,sha256=jGNKbV7f_FZxMqVOXtFyEcOMGdaySGFNHg6FO414dVM,36
+fastapp_cli/templates/project/app/api/v1/endpoints/health.py.j2,sha256=VQRKrGsbPqu6oI5PbGWIbjGFfD8tGr7fBSOlnR-YI64,804
+fastapp_cli/templates/project/app/api/v1/endpoints/items.py.j2,sha256=0CY0DPY0ngQ-ZzK5qfgjDqBqQMxtIK4HLOjST4NaqlM,2125
+fastapp_cli/templates/project/app/core/__init__.py.j2,sha256=e81XIYVsR5JFoTjAYaHSgwMbrvZFslkg5NHYduhoebw,18
+fastapp_cli/templates/project/app/core/celery_app.py.j2,sha256=wRKn8f8R0sa_gLdQIDZW-XtSg4_DAt8XFrWNWWgV8Zs,1990
+fastapp_cli/templates/project/app/core/config.py.j2,sha256=78U5T4TwNPL1YfFarRt_QEiCDDGZfDrEXy8QRnISPfA,3418
+fastapp_cli/templates/project/app/core/context_var.py.j2,sha256=9kJTc62lrwQ-gR90hU4onmYS07EedvlHdrsiRuIdBeE,393
+fastapp_cli/templates/project/app/core/database.py.j2,sha256=cU9qRBKv5v4JqXvYGnsFYK7lwRl61aG1tTEt-vCh6ss,1632
+fastapp_cli/templates/project/app/core/exceptions.py.j2,sha256=QB9hDnM-vkAGyKxpkRWZP6nnYaS03CzfUlRARYvfESg,4679
+fastapp_cli/templates/project/app/core/logging.py.j2,sha256=srcg78850B9IZEC7cNh8T4rZHUH-nHTY0XYLSYgyHTs,4633
+fastapp_cli/templates/project/app/core/middleware.py.j2,sha256=n4WDvcs4ESDUv9c2u2uYwH9gcckz9zIfHfCH19DurrU,1370
+fastapp_cli/templates/project/app/crud/__init__.py.j2,sha256=bXK8xQojkL-Dzunseo2kG6xifn9UUYENbuuA9prLCH8,18
+fastapp_cli/templates/project/app/crud/base.py.j2,sha256=xAuaNnKhjmJLAvNfAjBtl9rWs6ozl0c9SBRTMTtS7yA,8317
+fastapp_cli/templates/project/app/crud/item.py.j2,sha256=HCDcISBdL0G5OFlHN6R5wCMhSX5cp4c6zXyxBDb4K7Q,165
+fastapp_cli/templates/project/app/models/__init__.py.j2,sha256=MQuQgQKK1GWUJelOhwaVQtTMhiNwj2kkX-PCmhhzevU,165
+fastapp_cli/templates/project/app/models/base.py.j2,sha256=d0iqUD-lCinCLZPhQRFioBupyrMIKMgFY9JI3y560e0,1665
+fastapp_cli/templates/project/app/models/item.py.j2,sha256=-jfZ9tuh_-JeewyM8nj2m_m3ovMSRhvPaVGecG2VE0w,628
+fastapp_cli/templates/project/app/schemas/__init__.py.j2,sha256=EgTl4CaiQrmz5EpHs3xy3EGImsZHjlaT3VUMj1MdGC8,21
+fastapp_cli/templates/project/app/schemas/common.py.j2,sha256=ctHQ6WR_-XI7KhGOGoUo4-mX-xhuXZGPoVLY3bOvRdE,2279
+fastapp_cli/templates/project/app/schemas/item.py.j2,sha256=XMEuPKYWLJrCczeIGFdpPoKXD1l3jR6EvlWEyH-dSyg,1037
+fastapp_cli/templates/project/app/services/__init__.py.j2,sha256=Ctx-aTWgPrEsjpJGKxLxCoGxZuVsepJ67X6XLx-Ske8,22
+fastapp_cli/templates/project/app/services/base.py.j2,sha256=2c5sxkXq2pSszfdfdJvug0niZykKGu3QdurYPu10xcI,2742
+fastapp_cli/templates/project/app/services/item_service.py.j2,sha256=At3RNulYyfIBI2oQoDtT4vihRwVprt6Dt91flBcHMzI,192
+fastapp_cli/templates/project/app/tasks/__init__.py.j2,sha256=L302vJrLaiy-tlW_Cgka2E9baYtga9hv-p9-nLq7mx0,19
+fastapp_cli/templates/project/app/tasks/sample_tasks.py.j2,sha256=a5uGmymimeoShSN3A5ieitknJPQLe6HZrpHRMm_9i_U,802
+fastapp_cli/templates/project/app/utils/__init__.py.j2,sha256=nD_PAGL8PLUIq9hfUfaXXPvjV-E4Pw2_ItR76wuGMoE,19
+fastapp_cli/templates/project/docs/SQLModel定义示例.md,sha256=SwGKOKxMAzNgQ0cuO2LpeaFFV48HssBkvrkzeNYheF4,10064
+fastapp_cli/templates/project/scripts/celery_beat.sh.j2,sha256=7_S6MblPhGFw67IXYJsuej9-_AV2pLBpl45ZeVRGqWc,217
+fastapp_cli/templates/project/scripts/celery_flower.sh.j2,sha256=S-kTYD7xA8c7ZAEYyNIuiKNZ12sLb3mjxvBixaCefKA,603
+fastapp_cli/templates/project/scripts/celery_worker.sh.j2,sha256=4k3hKNP3J0RRS7TnObcn6Eza9iDRcSGQgUF4WpTcssM,328
+fastapp_cli/templates/project/scripts/start.sh.j2,sha256=hKY2bQv7-CwZsr4hUhO1Er-OYTCp4n5jLMUPrAnemlc,501
+fastapp_cli/templates/project/tests/conftest.py.j2,sha256=1fVdvNF7io7UMX31b-Sh_6RDpTMvtu_fTjFJQfSWYpM,1768
+fastapp_cli/templates/project/tests/api/test_health.py.j2,sha256=-sRDDETLcdrKfuoV-5IXgbnCERqPJQ2OmC4s5jwPe-s,457
+fastapp_cli/templates/project/tests/api/test_items.py.j2,sha256=qholB9OhVhbGc_oLZwISzkeoKc6bKYGjW8VPgUYEEDM,2040
+fastapp_cli/templates/project/tests/services/test_item_service.py.j2,sha256=pKHc64MJsv5b2NuX7hFpqzj2MbBZu5Kexe4VeTqpnYE,1313
+fastapp_cli-0.1.0.dist-info/METADATA,sha256=RhvhOPqzJ0kcNxedZ9DjlRt1dqux0Ma-718Dg25DP5k,3161
+fastapp_cli-0.1.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+fastapp_cli-0.1.0.dist-info/entry_points.txt,sha256=NONIEhUlTtuFCmV7CEykJzPhpjsplc7XLuWbjhFzFuc,49
+fastapp_cli-0.1.0.dist-info/RECORD,,

fastapp_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

fastapp_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fastapp = fastapp_cli.main:app