使用说明
Python-Boilerplate-LLM（Python模板-大型语言模型）
此仓库是用于Python项目开发的代码模板，旨在利用AI编码工具（如Cline/Cursor等）。它以LLM自动生成设计文档，并基于此进行实现的工作流为前提。
功能
- 基于LLM的设计文档自动生成与实现的一体化工作流程
- 基于设计书模板（docs/design.md.sample），LLM生成符合要求的设计书
- 使用UV的虚拟环境管理
- 通过src/和tests/目录进行结构化
- 主程序的入口点
- 使用pytest的测试示例
使用方法
开发环境的设置
方法1：本地环境
- 使用UV创建虚拟环境并安装包：
uv venv
- 安装开发包：
uv pip install -r requirements.txt
方法2：DevContainer
对于VS Code用户，可以使用DevContainer开发环境：
-
在VS Code中打开DevContainer：
F1→Dev Containers: Reopen in Container- 或在通知中选择用容器重新启动
-
Docker环境将自动设置，构建Python开发环境
执行主程序
python -m src.main
利用LLM的开发工作流程
此模板基于以下利用AI编码工具（如Cline/Cursor/Claude Code等）的开发工作流程：
- 向LLM传达项目需求
- 大型语言模型（LLM）
docs/design.md.sample基于模板，根据需求进行调整docs/design.md自动生成 - 基于生成的设计文档，LLM实现代码
- 编写和执行测试代码
通过这一工作流程，从需求定义到实现的整个过程都能保持一致性，从而实现高效开发。
给LLM的指令示例
このリポジトリを使って、以下の要件のプロジェクトを実装してください。
<プロジェクトの要件>
docs/design.md.sample をベースに設計書を作成し、その設計に基づいて実装を行ってください。
测试
执行测试：
pytest
设计书模板
docs/design.md.sample其中包含用于系统性地描述项目从需求定义到设计、开发过程的模板。该模板具有以下特点：
- 需求定义部分（基本信息、项目概述、功能需求、非功能需求等）
- 系统设计部分（架构、类设计、数据流、错误处理等）
- 开发工程环节（阶段、里程碑、风险管理等）
大语言模型（LLM）会参考此模板，并基于用户提供的需求自动生成具体的设计文档。用户可以确认生成的设计文档，并根据需要请求进行调整。
项目结构
.
├── docs/ # ドキュメント
│ └── design.md.sample # 設計書テンプレート（LLMが参照）
├── src/ # ソースコード
│ ├── __init__.py
│ └── main.py # メインエントリーポイント
├── tests/ # テストコード
│ ├── conftest.py
│ └── test_main.py # メインモジュールのテスト
├── .devcontainer/ # DevContainer設定ファイル
│ ├── devcontainer.json
│ ├── docker-compose.yml
│ └── Dockerfile
├── .claude/ # Claude Code設定
│ └── settings.local.json
├── rules.md # コーディングルール
├── .gitignore # Git無視ファイル設定
├── LICENSE # ライセンスファイル
├── README.md # このファイル
└── requirements.txt # 依存関係
