Package Helper 3#

PyPI Status Build Status Documentation Status License Code Coverage

Package Helper 3 helps to create, develop and maintain a Python package.

It is a fork/mix of audreyr/cookiecutter-pypackage, francois-durand/package_helper_2, and fpgmaas/cookiecutter-poetry.

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

  • Create your package in a few minutes with Cookiecutter and Poetry,

  • Develop and maintain your package with PyCharm,

  • Host your package on GitHub and leverage GitHub actions,

  • Publish your package on PyPi,

  • Publicly share your coverage on Codecov.

A simple Command-Line Interface initiates the creation of the package using a template of Python package. Here are the main features of the template:

  • Personalize default options.

  • Include example files for classes, with examples of documentation and testing.

  • Use Poetry for all-in-one management of dependencies and settings.

  • Documentation:

    • Use a GitHub action and GitHub Pages to publish the documentation.

    • Use sphinx.ext.napoleon to benefit from NumPy style of documentation.

    • Use ReadTheDocs or PyData themes.

    • Add a “reference” section in the documentation of the package.

  • Use a GitHub action to perform unit tests.

  • Use a GitHub action to deploy the package on PyPI.

  • Generate a local html page displaying the test coverage.

  • Use Codecov.

Documentation: https://balouf.github.io/package-helper-3/.