跳转到主要内容

Python命名空间包的Cookiecutter模板

项目描述

Cookiecutter 命名空间模板,用于Python包。

Downloads Updates Versions Contributors License pre-commit.ci status Docs

功能

  • 使用 unittestpytest 进行测试设置

  • Tox 测试:设置以轻松测试Python 3.8、3.9、3.10、3.11、3.12和pypy。

  • Sphinx 文档:准备好生成文档,例如,使用 ReadTheDocs

  • bump2version:使用单个命令进行预配置的版本提升

  • 如果cookiecutter-namespace-template 项目模板已更改,您可以使用以下命令应用这些更改

    $ cruft update
  • 可选:当您向主分支推送新标签时,自动发布到 PyPI(可选)

  • 可选:使用 TyperClick 的命令行界面

如果您真的想使用 Python 2 创建新包,尽管有 Python 2.7 倒计时放弃对 Python 2 的支持,那么请使用 cookiecutter-namespace-template <0.2。

快速入门

  1. 如果您尚未安装 Cookiecutter,请安装最新版本(需要 Cookiecutter 1.4.0 或更高版本)

    $ python -m pip install -U cruft
  2. 生成 Python 包项目

    $ python -m cruft create https://github.com/veit/cookiecutter-namespace-template.git
  3. 创建一个仓库并将项目放在那里。

  4. 注册 您的项目到 PyPI。

  5. 将仓库添加到您的 ReadTheDocs 账户并启用 ReadTheDocs 服务钩子。

  6. 如果您想在 README 文件中添加 pyup 徽章

    1. pyup.io 创建新账户或登录现有账户

    2. 点击绿色的 添加仓库 按钮

    3. 点击 固定 添加仓库

  7. 通过向主分支推送新标签来发布您的包。

拉取请求

如果您有首选设置的不同之处,我鼓励您将其分支出来创建自己的版本。如果拉取请求很小、原子化,并且能提高我的打包体验,我也接受。

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面