cookiecutter-pylibrary

Cookiecutter template for a Python python library

Notes:

This is largely designed to address this blog post about packaging python libraries.
- ... and it will save you from packaging pitfalls.
There's a bare library using this template (if you're curious about the final result): https://github.com/ionelmc/python-nameless.
If you have a web application (not a library) you might want to take a look at django-docker.

Table of Contents

Features
Requirements
Usage and options
- Developing the project
- Releasing the project
  - Version management
  - Building and uploading
Changelog
Questions & answers
Not Exactly What You Want?

Features

This is an "all inclusive" sort of template.

Tox for managing test environments for Python 2.7, 3.3, PyPy etc.
Pytest or Nose for testing Python 2.7, 3.3, PyPy etc.
Optional support for creating a tests matrix out of dependencies and python versions.
Coveralls_ or Codecov_ for coverage tracking (using Tox).
Documentation with Sphinx, ready for ReadTheDocs.
Configurations for:
- isort
- bumpversion
Support for C extensions (including coverage measurement for the C code). See c_extension_support_.
Packaging and code quality checks. This template comes with a tox environment (check) that will:
- Check if your README.rst is valid.
- Check if the MANIFEST.in has any issues.
- Run flake8 (a combo of PEP8, pyflakes and McCabe checks) or pylama

Requirements

Projects using this template have these minimal dependencies:

Cookiecutter - just for creating the project
Tox - for running the tests
Setuptools - for building the package, wheels etc. Now-days Setuptools is widely available, it shouldn't pose a problem :)

To get quickly started on a new system, just install setuptools and then install pip. That's the bare minimum to required install Tox and Cookiecutter. To install them, just run this in your shell or command prompt:

pip install tox cookiecutter

Usage and options

This template is more involved than the regular cookiecutter-pypackage.

First generate your project:

cookiecutter gh:evision-ai/cookiecutter-pylibrary

You will be asked for these fields:

Note

Fields that work together usually use the same prefix. If you answer "no" on the first one then the rest won't have any effect so just ignore them. Maybe in the future cookiecutter will allow option hiding or something like a wizard.

Field	Default	Description
`full_name`	"Ionel Cristian Maries"	Main author of this library or application (used in `AUTHORS.rst` and `setup.py`). Can be set in your `~/.cookiecutterrc` config file.
`website`	"https://blog.ionelmc.ro"	Website of the author (used in `AUTHORS.rst`). Can be set in your `~/.cookiecutterrc` config file.
`package_namespace`	"evision"	Python package namespace name (whatever you would import).
`package_name`	"lib"	Python package name (whatever you would import).
`project_name`	"Nameless"	Verbose project name, used in headings (docs, readme, etc).
`repo_username`	"ionelmc"	GitHub user name of this project (used for GitHub link). Can be set in your `~/.cookiecutterrc` config file.
`repo_hosting_domain`	"github.com"	Use `"no"` for no hosting (various links will disappear). You can also use `"gitlab.com"` and such but various things will be broken (like Travis configuration).
`repo_name`	"python-nameless"	Repository name on GitHub (and project's root directory name).
`distribution_name`	"nameless"	PyPI distribution name (what you would `pip install`).
`project_short_description`	"An example package [...]"	One line description of the project (used in `README.rst` and `setup.py`).
`year`	"now"	Copyright year (used in Sphinx `conf.py`).
`version`	"0.1.0"	Release version (see `.bumpversion.cfg` and in Sphinx `conf.py`).

The testing (tox.ini) configuration is generated from templates. For your convenience there's an initial bootstrap tox.ini, to get the initial generation going just run:

tox

After this you can create the initial repository (make sure you create an empty Github project):

git init .
git add .
git commit -m "Initial skel."
git remote add origin git@github.com:ionelmc/python-nameless.git
git push -u origin master

Then:

Add the repo to your ReadTheDocs account + turn on the ReadTheDocs service hook. Don't forget to enable virtualenv and specify docs/requirements.txt as the requirements file in Advanced Settings.

Developing the project

To run all the tests, just run:

tox

To see all the tox environments:

tox -l

To only build the docs:

tox -e docs

To build and verify that the built package is proper and other code QA checks:

tox -e check

Releasing the project

Before releasing your package on PyPI you should have all the tox environments passing.

Version management

This template provides a basic bumpversion configuration. It's as simple as running:

bumpversion patch to increase version from 1.0.0 to 1.0.1.
bumpversion minor to increase version from 1.0.0 to 1.1.0.
bumpversion major to increase version from 1.0.0 to 2.0.0.

You should read Semantic Versioning 2.0.0 before bumping versions.

Building and uploading

Before building dists make sure you got a clean build area:

rm -rf build
rm -rf src/*.egg-info

Note:

Dirty build or egg-info dirs can cause problems: missing or stale files in the resulting dist or strange and confusing errors. Avoid having them around.

Then you should check that you got no packaging issues:

tox -e check

And then you can build the sdist, and if possible, the bdist_wheel too:

python setup.py clean --all sdist bdist_wheel

To make a release of the project on PyPI, assuming you got some distributions in dist/, the most simple usage is:

twine upload --skip-existing dist/*.whl dist/*.gz dist/*.zip

In ZSH you can use this to upload everything in dist/ that ain't a linux-specific wheel (you may need setopt extended_glob):

twine upload --skip-existing dist/*.(whl|gz|zip)~dist/*linux*.whl

For making and uploading manylinux1 wheels you can use this contraption:

docker run --rm -itv $(pwd):/code quay.io/pypa/manylinux1_x86_64 bash -c 'set -eux; cd code; rm -rf wheelhouse; for variant in /opt/python/*; do rm -rf dist build *.egg-info && $variant/bin/python setup.py clean --all bdist_wheel; auditwheel repair dist/*.whl; done; rm -rf dist build *.egg-info'
twine upload --skip-existing wheelhouse/*.whl
docker run --rm -itv $(pwd):/code quay.io/pypa/manylinux1_i686 bash -c 'set -eux; cd code; rm -rf wheelhouse; for variant in /opt/python/*; do rm -rf dist build *.egg-info && $variant/bin/python setup.py clean --all bdist_wheel; auditwheel repair dist/*.whl; done; rm -rf dist build *.egg-info'
twine upload --skip-existing wheelhouse/*.whl

Note:

twine is a tool that you can use to securely upload your releases to PyPI. You can still use the old python setup.py register sdist bdist_wheel upload but it's not very secure - your PyPI password will be sent over plaintext.

Changelog

See CHANGELOG.rst.

Questions & answers

There's no Makefile?

Sorry, no Makefile yet. The Tox environments stand for whatever you'd have in a Makefile.

Why does tox.ini have a passenv = *?

Tox 2.0 changes the way it runs subprocesses - it no longer passes all the environment variables by default. This causes all sorts of problems if you want to run/use any of these with Tox: SSH Agents, Browsers (for Selenium), Appengine SDK, VC Compiler and so on.

cookiecutter-pylibrary errs on the side of convenience here. You can always remove passenv = * if you like the strictness.

Why is the version stored in several files (pkg/__init__.py, setup.py, docs/conf.py)?

We cannot use a metadata/version file [1] because this template is to be used with both distributions of packages (dirs with __init__.py) and modules (simple .py files that go straigh in site-packages). There's no good place for that extra file if you're distributing modules.

But this isn't so bad - bumpversion manages the version string quite neatly.

[1]	Example, an `__about__.py` file.

Not Exactly What You Want?

No way, this is the best. 😜

If you have criticism or suggestions please open up an Issue or Pull Request.

evision-ai / cookiecutter-pylibrary