SuperAPI AI 工具集

python-development-python-scaffold

编程与开发

查看项目

更新于 10-16 02:23

技能介绍

用途

本技能面向需要快速搭建 Python 项目的场景,专注生成“生产可用”的项目脚手架。它会根据用户需求先判断项目类型,再生成对应的目录结构、依赖配置、入口文件、测试与开发工具配置。

主要能力

  • 项目类型判定:可区分 FastAPI、Django、Library(库)、CLI、Generic(通用 Python 应用)等类型。
  • 使用 uv 初始化项目:执行 uv init <project-name>、uv venv,并配置 git 与 .gitignore。
  • 生成完整项目结构:输出包含目录树、pyproject.toml、入口文件、测试结构、README 与开发工具(Makefile、.env.example、.gitignore)。
  • 工具与配置:包含 Ruff 检查与格式化、pytest 配置与测试目录、类型提示,以及类型检查相关依赖(如 mypy)。

使用方式

  1. 分析项目类型:根据需求判断属于 FastAPI、Django、Library、CLI 还是 Generic。
  2. 使用 uv 初始化:
uv init <project-name>
cd <project-name>
git init
echo ".venv/" >> .gitignore
echo "*.pyc" >> .gitignore
echo "__pycache__/" >> .gitignore
echo ".pytest_cache/" >> .gitignore
echo ".ruff_cache/" >> .gitignore
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  1. 按所选类型生成结构:FastAPI 使用分层目录(api、core、models、schemas、services、tests),并生成 pyproject.toml、main.py 等;Django 使用 uv add django django-environ django-debug-toolbar 与 django-admin startproject config .、python manage.py startapp core;Library 使用 src 布局、py.typed 与 hatchling 构建配置;CLI 使用 Typer 与 Rich,并在 [project.scripts] 中声明入口。
  2. 配置开发工具:生成 .env.example、Makefile,包含 install、dev、test、lint、format、clean 等目标。

示例要点

  • FastAPI 的 pyproject.toml 依赖包括 fastapi、uvicorn[standard]、pydantic、pydantic-settings、sqlalchemy、alembic;dev 依赖含 pytest、pytest-asyncio、httpx、ruff。
  • FastAPI 的 main.py 会创建 FastAPI 实例、添加 CORSMiddleware、include_router 并暴露 /health。
  • Django 的 pyproject.toml 依赖包括 django、django-environ、psycopg[binary]、gunicorn;dev 依赖含 django-debug-toolbar、pytest-django、ruff。
  • Library 使用 hatchling 构建后端,wheel 包路径为 src/library_name。
  • CLI 使用 Typer 定义命令,并通过 Rich 输出。

适用场景

  • 需要快速创建一致、类型安全且结构规范的 Python 项目。
  • 需要为 FastAPI 或 Django 项目建立可扩展的分层架构与测试骨架。
  • 需要为可复用库或命令行工具建立标准发布结构。

限制

  • 资料未提供收费、价格、平台兼容性、性能或效果相关的具体信息。
  • 资料未提供除已列出的依赖、命令与配置之外的额外功能说明。
  • 部分配置(如 SECRET_KEY、DATABASE_URL)在示例中为占位值,需按实际环境替换。