cc-pypackage
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.
1 maintainer
Metadata
1 maintainer
Release files for cc-pypackage 0.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cc-pypackage-0.4.2.tar.gz | 20.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cc_pypackage-0.4.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.7 kB
Release files / cc-pypackage-0.4.2.tar.gz
| Download URL | cc-pypackage-0.4.2.tar.gz |
|---|---|
| Size | 20.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f6d9507ad54a1a06230c266d106463780f691f6627186204d7a1481f6b310282
|
|
BLAKE2b-256 checksum How to use checksums |
a67515cdad46563275d2dc9efba6f28a3ddb8785f3b323c5b224c8a82a0d78ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
|
Release files / cc_pypackage-0.4.2-py3-none-any.whl
| Download URL | cc_pypackage-0.4.2-py3-none-any.whl |
|---|---|
| Size | 3.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
15833076857ed2876dc7522f7fcd6bb1d0298e89a1507d784d94370356f36442
|
|
BLAKE2b-256 checksum How to use checksums |
275a6e3727a00bb4a24567ff2e6be1125c957b8a0fdfef5cea1dfc86ff488530
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
|
Security for cc-pypackage 0.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
