Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pritam001/pyflask-microservice-base

🗼 An "optionally opinionated and structured" flask boilerplate application for jump-starting microservice development with flask
https://github.com/pritam001/pyflask-microservice-base

boilerplate boilerplate-application conda-environment coverage flask flask-base flask-docker flask-tests project-structure pyflask pyflask-microservice python python3 static-analysis template template-project

Last synced: 1 day ago
JSON representation

🗼 An "optionally opinionated and structured" flask boilerplate application for jump-starting microservice development with flask

Awesome Lists containing this project

README 

        
[//]: <> (pyflask_config: service_name)

pyflask-microservice-base

------------------------------------------------------------------------------

An "optionally opinionated and structured" flask boilerplate microservice for jump-starting development



![Built with](https://img.shields.io/badge/-Built%20with-073551?style=flat-square)

![Python](https://img.shields.io/badge/-Python-3776AB?style=flat-square&logo=Python&logoColor=white)

![Flask](https://img.shields.io/badge/-Flask-000000?style=flat-square&logo=flask&logoColor=white)

![License](https://img.shields.io/github/license/pritam001/pyflask-microservice-base?style=flat-square&label=License)



Project status

------------------------------------------------------------------------------

![Version](https://img.shields.io/github/v/tag/pritam001/pyflask-microservice-base?logo=codesandbox)

[![Maintainability](https://api.codeclimate.com/v1/badges/cc34f11b1a2b9bb8e216/maintainability)](https://codeclimate.com/github/pritam001/pyflask-microservice-base/maintainability)

[![codecov](https://codecov.io/gh/pritam001/pyflask-microservice-base/branch/master/graph/badge.svg)](https://codecov.io/gh/pritam001/pyflask-microservice-base)



Tools

------------------------------------------------------------------------------

[![Min Python Version 3.7](https://img.shields.io/badge/python-3.7+-3776AB.svg?style=flat)](https://www.python.org/download/releases/3.8.0/)

[![Min GNU Make Version 4.3](https://img.shields.io/badge/make-4.3+-222222.svg?style=flat)](https://www.gnu.org/software/make/manual/make.html)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black)

[![Static Analysis: flake8](https://img.shields.io/badge/static%20analysis-flake8-cccccc.svg?style=flat)](https://github.com/PyCQA/flake8/)

[![Cyclomatic Complexity: radon](https://img.shields.io/badge/cyclomatic%20complexity-radon-ff5252.svg?style=flat)](https://github.com/rubik/radon)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://timothycrosley.github.io/isort/)

[![Static Typing: mypy](https://img.shields.io/badge/static%20typing-mypy-blue.svg?style=flat)](https://github.com/python/mypy/)

[![Security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg?style=flat)](https://github.com/PyCQA/bandit)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=flat&logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![API Specs](https://img.shields.io/badge/specs-flasgger-6D9A00?style=flat&logo=swagger&logoColor=white)](https://github.com/flasgger/flasgger)

[![Tests: pytest](https://img.shields.io/badge/%20tests-pytest-%23009BDB?style=flat)](https://docs.pytest.org/en/latest/contents.html)

[![Coverage: pytest-cov](https://img.shields.io/badge/%20coverage-pytest--cov-%23009BDB?style=flat)](https://docs.pytest.org/en/latest/contents.html)

[![Version Handling: tbump](https://img.shields.io/badge/%20version%20handling-tbump-%23009BDB?style=flat)](https://docs.pytest.org/en/latest/contents.html)



Usage Guide

------------------------------------------------------------------------------

This is a template project hosted on GitHub which can be used to create new repositories.



### Steps for creating boilerplate project in GitHub

1. Create a new repository named "my-pyflask-project" using this template repository *+

1. `git clone https://www.github.com/username/my-pyflask-project.git`

1. `cd my-pyflask-project`

1. `make init` : Initialize and personalize project

1. `make setup` : Use pip-tools, pip-compile, pip install to set up python packages

1. `make upgrade` : Upgrade dependencies to latest version

1. `make pre-commit` : Run format, lint, test and cover

1. Run `git add .` and `git commit -m "Personalize service"`



*+ [GitHub Guide: Creating a repository from a template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)




*^ [Guide to Conda environment](https://github.com/pritam001/pyflask-microservice-base/blob/master/documentation/wiki/conda.md)



### Make Guide

Type `make help` for available commands






Type `make pre-commit` before committing your changes to run formatters, linters, tests and code coverage collectors






### Linting Guide

`make format` : Format and fix python code with black, isort, autoflake and pre-commit hooks






`make lint` : Run static analysis with flake8, radon, mypy and bandit






### Documentation

[//]: <> (pyflask_config: service_name)

Flasgger docs can be found at http://0.0.0.0:8420/api/v1/pyflask-microservice/swagger



[//]: <> (pyflask_config: service_name)

API specs can be found at http://0.0.0.0:8420/api/v1/pyflask-microservice/swagger_spec



Flasgger UI version: v2 | OpenAPI version: 2






Contributing

------------------------------------------------------------------------------

1. Stargaze this repository

1. Fork this repository

1. Add this project as `upstream`

1. Commit your changes

1. Create pull request to `upstream/development` branch



Roadmap

-----------------------------------------------------------------------------

- [x] Swagger support

- [x] Introduction of testing tools

- [x] Code coverage

- [x] Version handling by tbump

- [ ] Personalization script

- [ ] Docker support

- [ ] uwsgi server

- [ ] Add CoC, Contribution guidelines, PR and issue templates

- [ ] Update linting documentation

- [ ] Testing tools documentation