Python包模板

最新发布
包状态
许可证
构建状态
覆盖率
Conda
文档

这是一个有偏见的尝试，记录了我如何部署一个带有文档、测试、PyPI和持续部署的Python应用程序。随着我改变我的Python开发实践，该项目将会更新。首先，这是一个学习经验。

• 文档（sphinx，自托管 + readthedocs）
• 测试（pytest）和覆盖率（pytest-cov）
• 部署到PyPI（twine）
• 部署到Conda（conda）
• 将Docker容器部署到（dockerhub 和 gitlab容器仓库）
• 构建包（setup.py，README.md，CHANGELOG.md，LICENSE.md）
• 使用argparse的命令行界面
• 测试、包和文档的徽章

假设

Gitlab将被用于持续部署。这是一个开源的伟大项目，具有许多GitHub上没有的出色功能。你应该考虑它！使用功能

• 页面
• CI/CD

如果您想为文档设置自定义域名并与 gitlab pages 配合使用，您需要使用 cloudflare。我有一篇关于如何操作的 博客，或者您也可以查看 gitlab cloudflare 文档。

步骤

此项目本身是一个 Python 包，完整的文档可以在 readthedocs 上找到。以下每个步骤都包含到文档中相应部分的链接。

1. 使用 git 仓库（setup.py，README.md，.gitignore，<package>）设置裸 Python 包
2. 使用 git 标签 vX.X.X 设置 pypi 部署
3. 使用 pytest 在每个提交上设置测试
4. 在 readthedocs 和自托管上使用 sphinx 设置文档

需求

无！

贡献

欢迎所有贡献，包括错误报告、错误修复、文档改进、增强和想法。

此项目的目标是引导我以有见地的态度进行现代 Python 打包开发。

许可证

MIT