Overview

The Flask Project Template is a comprehensive template for developing Flask applications. It provides a full feature Flask application with CLI, API, Admin interface, web UI, and modular configuration. The template includes various tools and features such as documentation structure using mkdocs, automatic generation of a change log, code linting, code coverage reports, automatic release to PyPI, and continuous integration using Github Actions. It also provides entry points for executing the program with CLI argument parsing.

Features

• Full feature Flask application: Includes CLI, API, Admin interface, web UI, and modular configuration.
• Setup.py file: Provides installation, packaging, and distribution for the project.
• Makefile: Includes useful commands to install, test, lint, format, and release the project.
• Documentation structure using mkdocs: Provides a structured documentation framework.
• Auto generation of change log: Maintains a HISTORY.md file based on commit history for each release.
• Containerfile: Allows building a container image for the project using buildah or Docker.
• Testing structure using pytest: Includes a testing framework for the project.
• Code linting using flake8: Ensures code quality and adherence to coding standards.
• Code coverage reports using codecov: Generates code coverage reports.
• Automatic release to PyPI using twine and Github actions: Facilitates automatic deployment to PyPI.
• Entry points with CLI argument parsing: Provides an easy way to execute the program with CLI arguments.
• Continuous integration using Github Actions: Includes jobs to lint, test, and release the project on different environments.