Overview

This project tries to implement an end to end python repository following 12 factor app methodology that includes CI/CD pipeline using Jenkins, code quality tools integration like pylint, mypy, flake8, isort, black and mkdocs for documentation using docstrings and typing within project source code.

Also, the template project is a REST API using FastAPI framework that implements a basic calculator. Pytest is used for unit and integration tests.

For full source code of this project please visit repo template.

How to use this repo

Please check how to use this repository in the repo README file

Open issues

Please check open issues at github

Changelog

[v0.0.4] - Replace pylint with ruff - Use pyproject.toml for project metadata and dependencies - Logger class - Observability OpenTelemetry format for prometheus scrape service

[v0.0.3] - Documentation migrated to readthedocs service - Dynamic badges for coverage (coveralls), documentation as stated before, build status (jenkins plugin) - API basic unit tests added