python-template
This project is an opinionated python template.
Usage
This project uses:
- poetry for dependency management and packaging.
- poethepoet for task running.
- pytest for testing.
- black for auto-formatting.
- mypy for static type checking.
- pre-commit for git hooks.
- ruff for linting.
- mkdocs for documentation.
Ensure you have installed the relevant dependencies before continuing.
Install dependencies
poetry install
Run tests
poetry run poe test
GitHub Actions Setup
Validation Workflow
CodeCov.io
The workflow is automatically setup to pass along coverage reports to CodeCov.io.
You must set the CODECOV_TOKEN secret in your repository settings.
Otherwise, disable the routine in the .github/workflows/validate.yaml file.
Publishing Workflow
Ensure you have Discussions enabled in your repository settings,
or remove discussion_category_name from the .github/workflows/publish.yaml file.
PyPi
The workflow is automatically setup to publish to PyPi.
You must set the POETRY_PYPI_TOKEN_PYPI secret in your repository settings.
Otherwise, disable the routine in the .github/workflows/publish.yaml file.
Metadata
Release files for python-template-x 0.4.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 | Provenance | Actions |
|---|---|---|---|---|
| python_template_x-0.4.1.tar.gz | 4.9 kB | Without provenance | Details for python_template_x-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| python_template_x-0.4.1-py3-none-any.whl | Python 3 | none | any | Details for python_template_x-0.4.1-py3-none-any.whl |
Total release size: 10.9 kB
Release files / python_template_x-0.4.1.tar.gz
| Download URL | python_template_x-0.4.1.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f026645defee0b46dfbae25d76d39d12e111136d12aee0f44d1bdff30754d34b
|
|
BLAKE2b-256 checksum How to use checksums |
0d3efd6b8acb1d8af5898fe51fcaabe39fd86561fe0720fcc346a182299734cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.10.15 Linux/6.5.0-1025-azure
|
Release files / python_template_x-0.4.1-py3-none-any.whl
| Download URL | python_template_x-0.4.1-py3-none-any.whl |
|---|---|
| Size | 6.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
05aa516ce208bb3b68edc954952653201169fa4fec545f7977e888357147de48
|
|
BLAKE2b-256 checksum How to use checksums |
efcd4529c431861c2a297abd77adb237ea58d53b9b06ee8d8c793ac92b3c12a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.10.15 Linux/6.5.0-1025-azure
|
Security for python-template-x 0.4.1
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.