Package Helper

Documentation Status

Important note: Package Helper is no longer maintained. We recommend you to migrate to Package Helper 2.

Package Helper explains how to create, develop and maintain a Python package.

The most prominent feature of Package Helper is a tutorial that gives a checklist of how to:

  • Create your package in a few minutes with Cookiecutter,
  • Develop and maintain your package with PyCharm.

Optionally, you can also use GitHub, ReadTheDocs, Travis-CI, PyPI, Codecov and Pyup. For more readability, the tools that you do not use can be hidden in the tutorial.

Package Helper also provides a template of Python package. It is a fork of https://github.com/audreyr/cookiecutter-pypackage/. Here are the main differences with the original template:

  • Personalize default options.
  • Include example files for classes, with examples of documentation and testing.
  • Documentation:
    • Use sphinx.ext.napoleon to benefit from NumPy style of documentation.
    • Use ReadTheDocs theme.
    • Add a “reference” section in the documentation of the package.
  • Make Travis run also the doctests.
  • Use Codecov.
  • Minor tweaks in setup.py.
  • Remove version numbers from requirements_dev.txt.

Documentation: https://package-helper.readthedocs.io/.