Package Helper 3 explains how to create, develop, and maintain a Python package with Poetry.
Project description
Package Helper 3
Package Helper 3 helps to create, develop and maintain a 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.
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/.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for package_helper_3-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34a60832cba9c66528466e76a5ce0e39f24386d476858c4ab389f5de36886144 |
|
MD5 | b0142b3a5e9cedf4f808c6c9d6babbad |
|
BLAKE2b-256 | 46f109b5e3f4d326bc9c429ce1c032176988df29c670ec44b104e0e2174c78c1 |