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 UV,
- 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.
- Archive your source code on Software Heritage for long-term preservation.
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:
-
Default options that can be personalized.
-
Include example files for classes, with examples of documentation and testing.
-
Use UV for all-in-one management of dependencies and settings.
-
Documentation:
- Use GitHub actions and GitHub Pages to publish the documentation.
- Use
sphinx.ext.napoleonto benefit from NumPy style of documentation. - Use PyData theme.
- Add a "reference" section in the documentation of the package.
-
Use GitHub actions to perform unit tests.
-
Use GitHub actions to deploy the package on PyPI.
-
Generate a local html page displaying the test coverage.
-
Use Codecov for getting a public badge of your test coverage.
Documentation: https://balouf.github.io/package-helper-3/.
1 maintainer
Metadata
1 maintainer
Release files for package-helper-3 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| package_helper_3-0.6.1.tar.gz | 42.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| package_helper_3-0.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 96.7 kB
Release files / package_helper_3-0.6.1.tar.gz
| Download URL | package_helper_3-0.6.1.tar.gz |
|---|---|
| Size | 42.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd505c0b30bd14b295eeac7b067f6d0627639e233eb45964e7932888890edf82
|
|
BLAKE2b-256 checksum How to use checksums |
44900a17a78075b2008e5ec0370218a512ff230b53fd9bef8b188b8e031ecd15
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / package_helper_3-0.6.1-py3-none-any.whl
| Download URL | package_helper_3-0.6.1-py3-none-any.whl |
|---|---|
| Size | 54.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ebe658aedfc235ff2299b9ff763c5486bf87b960d467f27b4e3bab6443b9a3f5
|
|
BLAKE2b-256 checksum How to use checksums |
361760f84eda49823a4ff65796ba4e0c4b4832f982c07e22236529d788d266b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
