Flask Project Template

A full feature Flask project template.

See also

• Python-Project-Template for a lean, low dependency Python app.
• FastAPI-Project-Template The base to start an openapi project featuring: SQLModel, Typer, FastAPI, JWT Token Auth, Interactive Shell, Management Commands.

HOW TO USE THIS TEMPLATE

DO NOT FORK this is meant to be used from Use this template feature.

1. Click on Use this template
2. Give a name to your project
   (e.g. my_awesome_project recommendation is to use all lowercase and underscores separation for repo names.)
3. Wait until the first run of CI finishes
   (Github Actions will process the template and commit to your new repo)
4. If you want codecov Reports and Automatic Release to PyPI
   On the new repository settings->secrets add your PIPY_API_TOKEN and CODECOV_TOKEN (get the tokens on respective websites)
5. Read the file CONTRIBUTING.md
6. Then clone your new project and happy coding!

NOTE: WAIT until first CI run on github actions before cloning your new project.

What is included on this template?

• 🍾 A full feature Flask application with CLI, API, Admin interface, web UI and modular configuration.
• 📦 A basic setup.py file to provide installation, packaging and distribution for your project.
  Template uses setuptools because it's the de-facto standard for Python packages, you can run make switch-to-poetry later if you want.
• 🤖 A Makefile with the most useful commands to install, test, lint, format and release your project.
• 📃 Documentation structure using mkdocs
• 💬 Auto generation of change log using gitchangelog to keep a HISTORY.md file automatically based on your commit history on every release.
• 🐋 A simple Containerfile to build a container image for your project.
  Containerfile is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.
• 🧪 Testing structure using pytest
• ✅ Code linting using flake8
• 📊 Code coverage reports using codecov
• 🛳️ Automatic release to PyPI using twine and github actions.
• 🎯 Entry points to execute your program using python -m <project_name> or $ project_name with basic CLI argument parsing.
• 🔄 Continuous integration using Github Actions with jobs to lint, test and release your project on Linux, Mac and Windows environments.

Curious about architectural decisions on this template? read ABOUT_THIS_TEMPLATE.md
If you want to contribute to this template please open an issue or fork and send a PULL REQUEST.

project_name Flask Application

project_description

Installation

From source:

git clone https://github.com/author_name/project_urlname project_name
cd project_name
make install

From pypi:

pip install project_name

Executing

This application has a CLI interface that extends the Flask CLI.

Just run:

$ project_name

or

$ python -m project_name

To see the help message and usage instructions.

First run

project_name create-db   # run once
project_name populate-db  # run once (optional)
project_name add-user -u admin -p 1234  # ads a user
project_name run

Go to:

• Website: http://localhost:5000
• Admin: http://localhost:5000/admin/
  • user: admin, senha: 1234
• API GET:
  • http://localhost:5000/api/v1/product/
  • http://localhost:5000/api/v1/product/1
  • http://localhost:5000/api/v1/product/2
  • http://localhost:5000/api/v1/product/3

Note: You can also use flask run to run the application.