首页
/ Scientific Python Cookiecutter 项目使用指南

Scientific Python Cookiecutter 项目使用指南

2024-09-25 19:08:56作者:姚月梅Lane

1. 项目介绍

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

2. 项目快速启动

2.1 安装依赖

首先,确保你已经安装了 copiercopier-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.tomlREADME.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 能够帮助开发者快速启动和维护高质量的科学计算项目。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
116
200
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
503
398
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
62
144
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
295
1.01 K
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
97
251
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
381
37
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
692
91
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
97
74
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
357
341