Short description of your project
Project description
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 docs
Makefile - 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
Master
branch); 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'
Project details
Release history Release notifications | RSS feed
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
Close
Hashes for your_project_name-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8928b0feaa3540d7c59c98947af3545827cb6fb74ea676ef328165c3e3c2cf2 |
|
MD5 | 5449d3481e0cb0a78bce942beb023d5c |
|
BLAKE2b-256 | 5e249f635e41138a4da83e882dc0b0eea9ab08a9f972fface6684ec782b278ce |