Skip to content
Pythonic cookiecutter template for a Python package. See
Branch: master
Clone or download
Pull request Compare This branch is 31 commits ahead, 573 commits behind audreyr:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.



Forked from cookiecutter template for a Python package. Forked from audreyr/cookiecutter-pypackage.

It is inspired by Flask and werkzeug's project style patterns. It is used on the tmuxp, cihai-python and vcspull projects.

  • Free software: BSD license
  • Vanilla testing setup with unittest and python test
  • Travis-CI: Ready for Travis Continuous Integration testing
  • Tox testing: Setup to easily test for Python 2.6, 2.7, 3.3
  • Sphinx docs: Documentation ready for generation with, for example, ReadTheDocs. Note: You can install sphinx docs requirements with $ pip install -r docs/requirements.txt.

Additions and changes


  • flask/werkzeug-style testsuites. See werkzeug testsuite on github.

  • Use to run all tests, or pass in arguments to test a particular TestSuite, TestCase or Test:

    $ ./
    $ ./ yourpackage
    $ ./ repo_name.repo_name  # package_name.TestSuite
    $ ./ yourpackage.testsuite.test_something
    $ ./ testsuite.test_something
    $ ./ test_something
    $ ./ test_something test_something_docstring
  • downloads unittest2 for python 2.6.

Python 2.7+3.3

  • from __future__ import absolute_import, division, print_function, \
        with_statement, unicode_literals
  • repo_name/ module (derived from flask, werkzeug and jinja2.) Why a compatibility module? See Armin Ronacher's post Porting to Python 3 Redux.


  • repo_name/ + repo_name/ Metadata in repo_name/ e.g. __title__, __author__ can be accessed via:

    >>> about = {}
    >>> with open("repo_name/") as fp:
    >>>     exec(, about)
    >>> print(about['__title__'])
    Your project name

    Keeps and doc/ in sync with package metadata. pypi and readthedocs distributions build off the latest package data.

    This method avoids cost of tokenizing and importing python file and avoids encountering potential import errors that may arise. It simply opens a vanilla python file and evals it.

    Derived from pypa/warehouse.

  • Relative imports in repo_name/

  • Relative imports in repo_name/testsuite/

  • Relative imports in repo_name/testsuite/{{ cookiecutter.package_name }}.py.


  • README.rst reStructuredText table for project information.
  • vim modelines for rst in TODO and CHANGELOG.
  • docs/requirements.txt, which can be targetted to install sphinx changelog package on ReadTheDocs. It will also trigger -r ../requirements.txt.
  • sphinx changelog module, (imitation of sqlalchemy, see sqlalchemy changelog)
  • Add TODO and docs/roadmap.rst.
  • Rename CHANGELOG.rst -> CHANGELOG.
  • Add docs/api.rst for documentation of API code. Initial class imported with docstring example.
  • Automatically generate header spacing based on length of cookiecutter variables.

Example data

  • Example TestCase.
  • Example Class w/ docstrings.


Install cookiecutter:

$ sudo pip install cookiecutter

Generate a Python package project:

$ cookiecutter


Not Exactly What You Want?

Don't worry, you have options:

Similar Cookiecutter Templates

Fork This / Create Your Own

If you have differences in your preferred setup, I encourage you to fork this to create your own version. Or create your own; it doesn't strictly have to be a fork.

  • Once you have your own version working, add it to the Similar Cookiecutter Templates list above with a brief description.
  • It's up to you whether or not to rename your fork/own version. Do whatever you think sounds good.

Or Submit a Pull Request

I also accept pull requests on this, if they're small, atomic, and if they make my own packaging experience better.

See also

You can’t perform that action at this time.