Your Project Name
Short description of your project
This project was generated with the python-cookiecutter template and, amongst other things, provides the following functionality out of the box.
- CI/CD integration with Woodpecker-CI pipelines
- Testing via Nox across multiple python versions
- PyTest integration with codecoverage, mocking and asyncio
- Linting with black and flake8
- Type checking with MyPy
- Security using bandit and safety
- Documentation via MkDocs with a material theme and autodoc
- Live reload during development with
make docsMakefile - Deployment to GitHub Pages through woodpecker pipeline using mike for version control
- Live reload during development with
- Package versioning and build with Poetry
- Deployment to both pypi (production) and test.pypi (development) through woodpecker pipelines based on branch
📚 Documenation
Documentation is hosted with GitHub Pages and can be found at:
- ✅ your-project-name/stable (reflecting the
Masterbranch); or - ⚠️ your-project-name/develop (for bleeding edge).
⚒️ Installation
Python Version: This library is tested against Python >=3.7
To install the library run this command in your terminal.
pip install your_project_name
🚀 Usage
TODO: improve documentation here
>>> import your_project_name
>>> your_project_name.__version__
'0.0.1'
1 maintainer
Metadata
1 maintainer
Release files for your-project-name 0.0.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 | |
|---|---|---|---|---|
| your_project_name-0.0.1.tar.gz | 4.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| your_project_name-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.9 kB
Release files / your_project_name-0.0.1.tar.gz
| Download URL | your_project_name-0.0.1.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4a86a0602304c75ab2dc16b9b10c65fdf2298d4208e5a452ad2577256181df89
|
|
BLAKE2b-256 checksum How to use checksums |
b13a39ef157bba117bf3aaa98981656ead22579e2f833d55892ee638ce263c08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.9.15 Linux/5.4.0-109-generic
|
Release files / your_project_name-0.0.1-py3-none-any.whl
| Download URL | your_project_name-0.0.1-py3-none-any.whl |
|---|---|
| Size | 3.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b8928b0feaa3540d7c59c98947af3545827cb6fb74ea676ef328165c3e3c2cf2
|
|
BLAKE2b-256 checksum How to use checksums |
5e249f635e41138a4da83e882dc0b0eea9ab08a9f972fface6684ec782b278ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.9.15 Linux/5.4.0-109-generic
|
Security for your-project-name 0.0.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.
