My custom Cookiecutter template for a Python package.
Project description
My custom Cookiecutter template for a Python package.
- GitHub repo: https://github.com/robertopreste/cc-pypackage/
- Documentation: https://cc-pypackage.readthedocs.io/
- Free software: BSD license
Features
- Testing setup with unittest and python setup.py test or pytest (used by default)
- Travis-CI: Ready for Travis Continuous Integration testing
- Tox testing: Setup to easily test for Python 3.4, 3.5, 3.6
- Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs
- Bumpversion: 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)
Quickstart
Install the latest Cookiecutter if you haven’t installed it yet (this requires Cookiecutter 1.4.0 or higher):
pip install -U cookiecutter
Generate a Python package project:
cookiecutter https://github.com/robertopreste/cc-pypackage.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 ReadTheDocs account + turn on the ReadTheDocs 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 cc-pypackage tutorial.
Credits
This Cookiecutter was adapted for my personal needs from the original Cookiecutter-PyPackage by audreyr.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size cc_pypackage-0.4.2-py3-none-any.whl (3.5 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size cc-pypackage-0.4.2.tar.gz (20.1 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for cc_pypackage-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15833076857ed2876dc7522f7fcd6bb1d0298e89a1507d784d94370356f36442 |
|
MD5 | f4439ef409522daa2d1f58c714105f10 |
|
BLAKE2-256 | 275a6e3727a00bb4a24567ff2e6be1125c957b8a0fdfef5cea1dfc86ff488530 |