Python Package Template (cookiecutter)¶
Python包 Cookiecutter 模板
开源协议: BSD license
特性&功能¶
Testing setup with
unittest
andpython setup.py test
orpytest
Travis-CI: Ready for Travis Continuous Integration testing
Tox testing: Setup to easily test for Python 3.5, 3.6, 3.7, 3.8
Sphinx docs: Documentation ready for generation with, for example, Read the Docs
bump2version: Pre-configured version bumping with a single command
Auto-release to PyPI when you push a new tag to master (optional)
Command line interface using Click (optional)
快速开始¶
Install the latest Cookiecutter if you haven’t installed it yet (this requires Cookiecutter 1.4.0 or higher):
pip install -U cookiecutter
生成一个Python包项目:
cookiecutter https://github.com/taceywong/py-pkg-template.git
Then:
Create a repo and put it there.
Add the repo to your Travis-CI account.
Install the dev requirements into a virtualenv. (
pip install -r requirements_dev.txt
)Register your project with PyPI.
Run the Travis CLI command
travis encrypt --add deploy.password
to encrypt your PyPI password in Travis config and activate automated deployment on PyPI when you push a new tag to master branch.Add the repo to your Read the Docs account + turn on the Read the Docs service hook.
Release your package by pushing a new tag to master.
Add a
requirements.txt
file that specifies the packages you will need for your project and their versions. For more info see the pip docs for requirements files.Activate your project on pyup.io.
For more details, see the `cookiecutter-pypackage tutorial`_.