Python Package Template
| Latest Release | |
|
|
|
| Package Status | |
| License | |
| Build Status |
|
| Coverage | |
| Conda |
|
| Documentation |
|
This is an opinionated attempt to document how I deploy a python application with documentation, testing, pypi, and continuous deployment. This project will be updated as I change my python development practices. Number one this is a learning experience.
- documentation (sphinx, selfhosted + readthedocs)
- testing (pytest) and coverage (pytest-cov)
- deploy to pypi (twine)
- deploy to conda (conda)
- deploy docker container to (dockerhub and gitlab container registry)
- building a package (
setup.py,README.md,CHANGELOG.md,LICENSE.md) - command line interface with argparse
- badges for testing, packages, and documentation
Assumptions:
Gitlab will be used for the continuous deployment. It is a great project that is open source and comes with many nice features not available for Github. You should consider it! Features used:
If you would like a custom domain setup with gitlab pages for the documentation you will need to use cloudflare. I have a blog written on how to do this or you can look at the gitlab cloudflare documentation.
Steps
This project is a python package itself and full documentation is available on readthedocs. Each of the steps below includes a link to the section in the documentation.
- setup a bare python package with git repo (
setup.py,README.md,.gitignore,<package>) - setup pypi deployment with git tags
vX.X.X - setup testing on each commit with
pytest - setup documentation with
sphinxon readthedocs and self hosted
Requirements
None!
Contributing
All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.
The goal of this project is to in an opinionated way guide modern python packaging development for myself.
License
MIT
Metadata
Release files for pypkgtemp 1.2.0
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 |
|---|---|---|---|---|
| pypkgtemp-1.2.0.tar.gz | 4.1 kB | Without provenance | Details for pypkgtemp-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pypkgtemp-1.2.0-py3-none-any.whl | Python 3 | none | any | Details for pypkgtemp-1.2.0-py3-none-any.whl |
Total release size: 11.0 kB
Release files / pypkgtemp-1.2.0.tar.gz
| Download URL | pypkgtemp-1.2.0.tar.gz |
|---|---|
| Size | 4.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
022c0d0a187b549dfaf375b637128e4c3925359f8438fe391c3f1b0d538993ef
|
|
BLAKE2b-256 checksum How to use checksums |
836a078f35909bbad794a8d5c985ecf5fc10f075a2d3a006c89010f57e005213
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / pypkgtemp-1.2.0-py3-none-any.whl
| Download URL | pypkgtemp-1.2.0-py3-none-any.whl |
|---|---|
| Size | 6.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f9d8fb34eb856f805d6990ef39991a19acbf98c4a12e79c4becce603bfa5a914
|
|
BLAKE2b-256 checksum How to use checksums |
c664d90c0a4b5f9842decca2fa077b67d964b94f1b6315ac072f5594201b25c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for pypkgtemp 1.2.0
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.