cookiecutter

饼干切割机

使用此命令行实用程序从cookiecutter （项目模板）快速创建项目。非常适合生成 Python 包项目等。

• 文档
• GitHub
• 皮伊
• 许可证（BSD）

安装

使用 pip 包管理器安装 cookiecutter：

 # pipx is strongly recommended.
pipx install cookiecutter

# If pipx is not an option,
# you can install cookiecutter in your Python user directory.
python -m pip install --user cookiecutter

特征

• 跨平台：支持Windows、Mac和Linux。
• 用户友好：无需 Python 知识。
• 多功能：兼容Python 3.7至3.12。
• 多语言支持：使用任何语言或标记格式的模板。

对于用户

快速入门

使用 Cookiecutter 作为命令行实用程序的推荐方法是使用pipx运行它，可以使用pip install pipx安装它，但如果您打算以编程方式使用 Cookiecutter，请运行pip install cookiecutter 。

使用 GitHub 模板

 # You'll be prompted to enter values.
# Then it'll create your Python package in the current working directory,
# based on those values.
# For the sake of brevity, repos on GitHub can just use the 'gh' prefix
$ pipx run cookiecutter gh:audreyfeldroy/cookiecutter-pypackage

使用本地模板

$ pipx run cookiecutter cookiecutter-pypackage/

从 Python 使用它

 from cookiecutter . main import cookiecutter

# Create project from the cookiecutter-pypackage/ template
cookiecutter ( 'cookiecutter-pypackage/' )

# Create project from the cookiecutter-pypackage.git repo template
cookiecutter ( 'gh:audreyfeldroy//cookiecutter-pypackage.git' )

详细使用方法

• 从本地或远程模板生成项目。
• 使用cookiecutter.json提示自定义项目。
• 利用提示前、生成前和生成后挂钩。

了解更多

对于模板创建者

• 利用无限的目录嵌套。
• 使用 Jinja2 来满足所有模板需求。
• 使用cookiecutter.json轻松定义模板变量。

了解更多

可用模板

在 GitHub 上发现各种即用型模板。

特殊模板

• cookiecutter pypackage
• cookiecutter-django
• cookiecutter-pytest-插件
• cookiecutter-plone-启动器

社区

加入社区、做出贡献或寻求帮助。

• 故障排除指南
• 堆栈溢出
• 不和谐
• 提出问题
• 贡献者
• 贡献指南

支持

• 在 GitHub 上给我们加星标。
• 请继续关注即将推出的支持选项。

反馈

我们重视您的反馈。建设性地分享您的批评或投诉，以帮助我们改进。

• 提出问题

正在等待回复？

• 请保持耐心并考虑向社区寻求帮助。
• 对于紧急事宜，请联系@audreyfeldroy 进行咨询或定制开发。

行为守则

在项目生态系统的所有交互过程中遵守 PyPA 行为准则。

致谢

由 Audrey Roy Greenfeld 创建和领导，并得到专门的维护者和贡献者团队的支持。