Pypkg: The example package

Pypkg is an example package that exists as an aid to the Python Packaging User Guide Tutorial and demonstrates best practices for Python packages. This fork has been customized to suit my own preferences.


  • Instructions to create your own packages
  • Example documentation
  • Examples tests
  • LICENSE, CHANGES.rst changelog, etc.
  • A recommended README organization
The example pypkg package has been published like a production package
  • Versioned and deployed to PyPI
  • Hosted Sphinx ReadTheDocs documentation
  • Continuous integration with TravisCI
  • README badges/shields setup

User Guide

This part of the documentation describes Pypkg and provides instructions to get started.