An "optionally opinionated and structured" flask boilerplate microservice for jump-starting development
This is a template project hosted on GitHub which can be used to create new repositories.
- Create a new repository named "my-pyflask-project" using this template repository *
git clone https://www.github.com/username/my-pyflask-project.git
cd my-pyflask-project
- Create and activate conda environment
conda activate my-conda-venv
** make setup
: Use pip-tools, pip-compile, pip install to setup python packages
* GitHub Guide: Creating a repository from a template
** Guide to Conda environment
Type make help
for available commands
make format
: Format and fix python code with black, isort, autoflake
make lint
: Run static analysis with flake8, radon, mypy and bandit
Flasgger docs can be found at http://0.0.0.0:8420/api/v1/pyflask-service/swagger
API specs can be found at http://0.0.0.0:8420/api/v1/pyflask-service/swagger_spec
Flasgger UI version: v2 | OpenAPI version: 2
To be updated
- Swagger support
- Update linting documentation
- Introduction of testing tools
- Testing tools documentation
- Version handling by tbump
- Add CoC, Contribution guidelines, PR and issue