package-helper-3 0.1.0

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

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

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.

For more readability, the tools that you do not use can be hidden in the tutorial.

A simple Command-Line Interface initiates the creation of the package using a template of Python package. It is a fork/mix of https://github.com/audreyr/cookiecutter-pypackage/, https://github.com/francois-durand/package_helper_2/, and https://github.com/fpgmaas/cookiecutter-poetry. 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 theme.

  • 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/.