pypi-packaging-template
This is a basic template that I keep updated with PyPi packaging best practices in an effort to speed up the process of packaging my python based git repositories. I hope you find these of use to you.
This README.md file is also made as a general template so as to be useful for other projects.
Installation
Use the package manager pip to install example-pkg.
pip install nickffs-example-pkg
Usage
from helloworld import hello_world
hello_world()
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
References
- Python's Official Packaging Tutorial: A tutorial on how to get your own PyPi package.
- Choose a license: A site that explains all the different Licenses out there and which you need to choose for you project.
- Make a ReadMe: Another really helpful site explaining what are READMEs and how to make them.
License
Metadata
Release files for nickffs-example-pkg 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nickffs-example-pkg-0.0.5.tar.gz | 2.3 kB | Without provenance | Details for nickffs-example-pkg-0.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nickffs_example_pkg-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for nickffs_example_pkg-0.0.5-py3-none-any.whl |
Total release size: 5.5 kB
Release files / nickffs-example-pkg-0.0.5.tar.gz
| Download URL | nickffs-example-pkg-0.0.5.tar.gz |
|---|---|
| Size | 2.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa06c9a1dbe52359b1bfda2ff938b78c66310b88f7eb68a9a528d395b6d3729a
|
|
BLAKE2b-256 checksum How to use checksums |
43832b7fb70013e2c83088eb85a9e75882caee57d9074370136a4c41da51f16e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.1
|
Release files / nickffs_example_pkg-0.0.5-py3-none-any.whl
| Download URL | nickffs_example_pkg-0.0.5-py3-none-any.whl |
|---|---|
| Size | 3.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
67bed2dee5d3da4c27e0ff98a1a86cbdd2f6ec2fc47c18b17857200540c85fca
|
|
BLAKE2b-256 checksum How to use checksums |
0653c84effe84ed39d27bd972d71f114e23fb7be24bfdc35bb86fedb3c273d40
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.1
|
Security for nickffs-example-pkg 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.