CategorizeLabel/docs/AICoding_prompt/Project_Initialization_prompt.md

96 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2025-10-15 17:19:26 +08:00
1. **初始化仓库:** 创建项目文件夹初始化Git仓库。使用`git init`创建仓库,并将.git文件夹放置于项目根目录下。
2. **虚拟环境:** 创建并激活虚拟环境。
- **创建虚拟环境** 使用以下命令创建一个新的虚拟环境:`conda create -n <环境名称> python=<版本号>`
备注python版本3.12.11,环境名称为文件夹名称。
- **激活虚拟环境** 激活刚创建的虚拟环境:`conda activate <环境名称>`
- **退出虚拟环境** 使用以下命令退出当前激活的虚拟环境:`conda deactivate`
- **删除虚拟环境** 如果需要删除某个虚拟环境,使用以下命令:`conda remove -n <环境名称> --all`
3. **依赖管理:**
1. **安装 Poetry** 在激活的 Conda 环境中安装 Poetry。
```pip install poetry
conda install poetry
```
2. **取消环境建立:**配置 Poetry 不创建独立的虚拟环境,而是使用当前激活的 Conda 环境。
```
poetry config virtualenvs.create false
```
3. **初始化**
```
poetry init
```
4. **代码风格/质量工具:** 安装 black, flake8并配置 pre-commit 钩子。
1. 安装开发依赖
```
poetry add --dev black flake8 pre-commit
```
2. 配置 Black (可选):在 pyproject.toml 文件中添加 Black 配置
```
# pyproject.toml
[tool.black]
line-length = 88
target-version = ['py312']
```
3. 配置 Flake8在项目根目录下创建 .flake8 文件,配置风格检查规则。
```
# .flake8
[flake8]
max-line-length = 88
ignore = E501, W503 # 忽略 Black 处理的行长和运算符断行问题
exclude =
.git,
__pycache__,
.venv,
# src/ # 如果你使用 src 布局
```
4. 配置 pre-commit 钩子
```
# .pre-commit-config.yaml
repos:
- repo: https://github.com/psf/black
rev: 23.3.0 # 使用最新版本
hooks:
- id: black
- repo: https://github.com/pycqa/flake8
rev: 6.0.0 # 使用最新版本
hooks:
- id: flake8
```
5. 安装 pre-commit 钩子:执行此命令,将 pre-commit 钩子安装到你的 Git 仓库中。
```codeBash
pre-commit install
```
5. **初始代码结构:**
```
project/
├── src/
├── config/
├── tests/
├── docs/
├── logs/
├── .gitignore
├── README.md
└── pyproject.toml
```