your-project-name 0.0.1

Short description of your project

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
• 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'