About

The aim of this project was to write a deploy a package that utilises best practices when it comes to software engineering and general python programming.

The key elements of this project are the following:

Python Coding

• Object oriented Python with class methods and decorators
• Type hinting parameters and results
• REST APIs and OAuth2.0 authentication

CICD

• Pre-commit hooks
• flake8, black for formatting
• mypy for type hint checking

Documentation

• Github repo
• mkdocs
• mkdocstrings