Scientific Python Cookiecutter 项目使用指南

1. 项目介绍

Scientific Python Cookiecutter 是一个用于创建新 Python 项目的模板，基于 Scientific Python 开发指南。该项目旨在提供一个标准化和高效的工具集，帮助开发者快速启动新的科学计算项目。它包含了多种构建工具和配置选项，支持多种后端（如 hatch、flit、pdm 等），并且与 GitHub Actions 集成，确保项目生成和测试的自动化。

2. 项目快速启动

2.1 安装依赖

首先，确保你已经安装了 copier 和 copier-templates-extensions。你可以使用 pipx 来安装这些工具：

pipx install copier
pipx inject copier copier-templates-extensions

2.2 生成项目

使用 copier 生成新项目：

copier copy gh:scientific-python/cookie <pkg> --trust

其中 <pkg> 是你希望放置新项目的路径。如果你使用的是旧版本的 copier，请使用 --UNSAFE 代替 --trust。

2.3 项目结构

生成项目后，你将看到以下基本结构：

<pkg>/
├── devcontainer/
├── github/
├── docs/
├── helpers/
├── src/
├── tests/
├── .gitignore
├── .gitattributes
├── .pre-commit-config.yaml
├── .pre-commit-hooks.yaml
├── .readthedocs.yaml
├── .ruby-version
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── README.md
├── _config.yml
├── action.yml
├── cookiecutter.json
├── copier.yml
├── noxfile.py
├── pyproject.toml

2.4 配置和启动

根据你的需求，修改 pyproject.toml 和 README.md 文件。然后，你可以使用 nox 来运行本地测试：

nox -l  # 查看所有命令
nox -s "lint(setuptools)"  # 运行特定检查

3. 应用案例和最佳实践

3.1 应用案例

Scientific Python Cookiecutter 特别适用于以下场景：

• 科学计算项目：需要快速启动一个符合科学计算标准的 Python 项目。
• 多后端支持：项目需要支持多种构建工具（如 hatch、flit、pdm 等）。
• 自动化测试：希望通过 GitHub Actions 自动化测试和部署流程。

3.2 最佳实践

• 选择合适的后端：根据项目需求选择合适的构建工具（如 hatch 适合纯 Python 项目，scikit-build 适合 C++ 项目）。
• 定期更新模板：使用 copier 的 --vcs-ref=HEAD 选项获取最新版本，确保项目配置和工具集保持最新。
• 文档和测试：确保项目包含完整的文档和测试，使用 nox 进行本地测试，并通过 GitHub Actions 进行持续集成。

4. 典型生态项目

Scientific Python Cookiecutter 与以下生态项目紧密结合：

• Scientific Python 开发指南：项目模板基于该指南，确保项目符合科学计算的最佳实践。
• GitHub Actions：自动化测试和部署流程，确保代码质量和持续集成。
• PyPI：通过 GitHub Actions 自动发布包到 PyPI，简化发布流程。
• ReadTheDocs：自动生成和部署项目文档，确保文档的及时更新和可访问性。

通过这些生态项目的支持，Scientific Python Cookiecutter 能够帮助开发者快速启动和维护高质量的科学计算项目。