Python包的Cookiecutter模板
项目描述
SciCookie 是一个项目模板，旨在简化科学Python项目的创建。它提供了一个带有推荐工具、工作流程和行业最佳实践的初始结构，节省了开发者的时间和精力。基于PyOpenSci推荐，它提供了一个符合科学Python标准的同时可针对特定项目需求进行定制的基座。
主要功能
- 项目结构： 之间选择 "src"（代码在子目录中）和 "flat"（所有文件都在顶级目录中）布局。
- 打包和依赖关系： 支持Poetry、Flit、meson-python、setuptools、PDM、Hatch、Maturin、scikit-build-core或setuptools + pybind11以灵活的构建系统。
- 测试和linting： 集成pytest、hypothesis、black（自动格式化）、bandit（安全性）、pydocstyle（文档样式）、vulture（未使用代码检测）和McCabe（循环复杂度分析），以创建强大的开发环境。
- 版本控制和自动化： 包括初始git集成、conda（基本环境）支持、pre-commit钩子、与GitHub Actions的持续集成以及语义发布的工作流程。
- 文档： 提供mkdocs、sphinx-rst、sphinx-myst、jupyter-book或quarto文档生成选项。
- 容器化： 提供使用Docker或Podman运行和管理容器的初始文件。
好处
- 减少样板代码： SciCookie消除了编写重复的项目设置代码的需要，使开发者能够专注于核心功能。
- 确保一致性： 强制执行标准化的结构，促进代码可维护性和协作。
- 遵循最佳实践： 利用 PyOpenSci 建议进行高效的科学 Python 开发。
- 提高代码质量： 集成各种测试和代码风格检查工具，以实现更好的代码维护。
- 自动化工作流程： 简化文档生成、版本控制和持续集成等流程。
入门指南
先决条件
- Python：请确保您的系统已安装 Python。您可以在终端中运行
python --version或python3 --version来检查。如果没有安装，可以从 这里 下载。
安装
- 安装 Cookiecutter（如果尚未安装）：打开您的终端并运行以下命令：
pip install scicookie
项目创建
-
导航到您希望的项目目录：使用
cd命令导航到您希望创建新 Python 包项目的目录。例如：cd ~/dev/my-python-projects（将~/dev/my-python-projects替换为您首选的目录路径。） -
使用 SciCookie 生成项目：一旦进入您希望进入的目录，运行以下命令以使用 SciCookie 生成新的 Python 包项目：
scicookie
（SciCookie 将为您的项目创建一个新的目录结构，包括科学 Python 项目中常用的文件和文件夹。现在您可以根据具体需求开始编辑和自定义项目。）
或者
- 使用 SciCookie 生成项目（可选 OSL 配置文件）：
scicookie --profile osl
（使用 --profile osl 标志可以在 OSL 推荐的配置下生成项目。如果省略，则使用默认的 SciCookie 配置文件。）
社区
支持
- 在 GitHub 上关注我们。
- 敬请期待即将推出的支持选项。
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个，请了解更多关于 安装包 的信息。
源代码分发
scicookie-0.9.0.tar.gz (98.7 kB 查看散列值)
构建分发
scicookie-0.9.0-py3-none-any.whl (134.2 kB 查看散列值)
关闭
scicookie-0.9.0.tar.gz 的散列值
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | f8d26f50b8e49c05949d90f50703d1747585f0a1e40116c321acefb2347399c2 |
|
| MD5 | eee277c0ace6bbf475075368a2242484 |
|
| BLAKE2b-256 | fdf82e38cd033e1ea93c8bf4ef58a0e07de2c90891411ae8dd6aad31bde6c16c |