A template to create other PyPi packages.
Project description
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 example-pkg
Usage
# this is some python code.
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
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
File details
Details for the file nickffs-example-pkg-0.0.1.tar.gz.
File metadata
- Download URL: nickffs-example-pkg-0.0.1.tar.gz
- Upload date:
- Size: 2.3 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 47d0fc78c75da9b5363d3bcd319f076bc5df5a609a2c726279689d3407aaf778 |
|
| MD5 | 9589a8b11a99592b606f80a5db24ea00 |
|
| BLAKE2b-256 | 9b60af5adb7437aca288a6b6cf4d7f307b1754f861fecf9e5af36e73a1519340 |
Provenance
File details
Details for the file nickffs_example_pkg-0.0.1-py3-none-any.whl.
File metadata
- Download URL: nickffs_example_pkg-0.0.1-py3-none-any.whl
- Upload date:
- Size: 3.2 kB
- Tags: Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5ec53f560af5a38a1b69c486b549d170331398677c801b035af2560590354fce |
|
| MD5 | 2d970bd5f15eeab9e485a157ea285554 |
|
| BLAKE2b-256 | 59dd749101525b5f1bc5f01721ecfe5e031bc2c367c0e25eb28aa8739af399d9 |
