python-library-template

A github repo template using python3 with:

• BDD testing strategies (using Gherkin and Behave through Tox)
• Python package control through poetry
• Pre-commit for detecting secrets, typing, linting (Detect-Secrets,Mypy, Black)
• ...

Index

This template repo starts with some examples:

• View All Docs
• Developer Setup
• Testing Strategy

Project Structure

The project is structured with the following in mind:

• docs/
  • Documentation around the project
• project_template/
  • Operational source code exists here
• tests/bdd/
  • BDD feature testing with Behave and Gherkin feature files
• tests/resources/
  • Resources of various files types, exist here

Prerequisites

Please ensure following the Developer Setup before developing
for this project to ensure correct environment setup.

It is also suggested to view the others docs as well.