python包模板
pypkgtemp的Python项目详细描述
python包模板
Latest Release | |
Package Status | |
License | |
Build Status | |
Coverage | |
Conda | |
Documentation |
这是一个自以为是的尝试,旨在记录我如何部署python 带有文档、测试、pypi和continuous的应用程序 部署。此项目将在我更改python时更新 发展做法。第一,这是一次学习经历。
- 文档(sphinx,自托管+readthedocs)
- 测试(pytest)和覆盖率(pytest-cov)
- 部署到pypi(twine)
- 部署到conda(conda)
- 将Docker容器部署到(dockerhub和gitlab container registry)
- 构建包(
setup.py
,README.md
,CHANGELOG.md
,LICENSE.md
) - 带有argparse的命令行接口
- 用于测试、软件包和文档的徽章
假设:
Gitlab将用于连续部署。太棒了 这个项目是开源的,有很多不错的特性 可用于Github。你应该考虑一下!使用的功能:
如果您希望使用gitlab页面为 需要使用的文档 cloudflare。我有一个blog written on how to do this 或者你可以看看gitlab cloudflare documentation。
步骤
这个项目本身就是一个python包,完整的文档是 在ReadtheDocs上可用。下面的每个步骤都包含指向 文档中的部分。
- setup a bare python package带git回购(
setup.py
,README.md
,.gitignore
,<package>
) - setup pypi deployment带有git标记
vX.X.X
- setup testing每次提交时使用
pytest
- setup documentation与
sphinx
在readthedocs上,并自托管
要求
没有!
贡献
所有贡献,错误报告,错误修复,文档改进, 我们欢迎您的改进和想法。
这个项目的目标是以一种自以为是的方式引导现代人 python为我自己打包开发。
许可证
麻省理工学院