我为python包定制的cookiecutter模板。
cc-pypackage的Python项目详细描述
我为python包定制的Cookiecutter模板。
- Github回购:https://github.com/robertopreste/cc-pypackage/
- 文档:https://cc-pypackage.readthedocs.io/
- 免费软件:BSD许可证
功能
- 使用unittest和python setup.py test或pytest(默认使用)测试安装程序
- Travis-CI:准备好进行travis连续集成测试
- Tox测试:设置为轻松测试python 3.4、3.5、3.6
- Sphinx文档:准备好生成的文档,例如,ReadTheDocs
- Bumpversion:使用一个命令预配置版本缓冲
- 当您将一个新标记推送到master(可选)时,自动释放到PyPI
- 使用click的命令行界面(可选)
快速启动
如果您还没有安装最新的CookieCutter(这需要 Cookiecutter 1.4.0或更高版本):
pip install -U cookiecutter
生成python包项目:
cookiecutter https://github.com/robertopreste/cc-pypackage.git
然后:
- 创建一个回购协议并放在那里。
- 将回购协议添加到您的Travis-CI帐户。
- 将开发人员需求安装到virtualenv中。(pip install -r requirements_dev.txt)
- Register使用pypi的项目。
- 运行travis cli命令travis encrypt–add deploy.password在travis config中加密您的pypi密码 并在将新标记推送到主分支时激活pypi上的自动部署。
- 将repo添加到您的ReadTheDocs帐户并打开readthedocs服务挂钩。
- 通过将新标签推给master来释放您的包。
- 添加一个requirements.txt文件,指定需要的包 您的项目及其版本。有关更多信息,请参见pip docs for requirements files。
- 在pyup.io上激活项目。
有关详细信息,请参见cc-pypackage tutorial。
学分
这个炊具是根据我的个人需要,由原来的Cookiecutter-PyPackage改成的audreyr。