https://github.com/kigawas/flask-scaffold

A scaffold to speed up launching a flask project.
https://github.com/kigawas/flask-scaffold

circleci docker flask flask-scaffold git-hooks python3 scaffold starter-kit

Last synced: 10 days ago
JSON representation

A scaffold to speed up launching a flask project.

• Host: GitHub
• URL: https://github.com/kigawas/flask-scaffold
• Owner: kigawas
• License: mit
• Created: 2018-10-24T06:33:48.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-01T18:03:44.000Z (about 1 month ago)
• Last Synced: 2024-10-18T15:07:00.221Z (19 days ago)
• Topics: circleci, docker, flask, flask-scaffold, git-hooks, python3, scaffold, starter-kit
• Language: Python
• Homepage:
• Size: 866 KB
• Stars: 11
• Watchers: 3
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flask-scaffold

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/81fa5c454ada4729bdbc3c1d8b2722bd)](https://app.codacy.com/app/kigawas/flask-scaffold)

[![Github Actions](https://img.shields.io/github/checks-status/kigawas/flask-scaffold/master)](https://github.com/kigawas/flask-scaffold/actions)

[![Docker Build Status](https://img.shields.io/docker/cloud/build/kigawas/flask-scaffold.svg)](https://hub.docker.com/r/kigawas/flask-scaffold/)

[![License](https://img.shields.io/github/license/kigawas/flask-scaffold.svg)](https://github.com/kigawas/flask-scaffold)

A scaffold to speed up launching a flask project, set up with [minimal dependencies](https://github.com/kigawas/flask-scaffold/blob/master/pyproject.toml).

You can just remove `LICENSE`, `.git/`, and `.vscode/` files if you don't need them.

There is no silver bullet, so if other libraries or practice are preferred, you can add or change anything as you like.

## Prerequisites

- Python 3.10+

- Poetry

- (Optional) Docker and docker compose

## Main features

- [APIFlask](https://apiflask.com/)

- Blueprint templates to organize directory structure

- Colorful logger in terminals, stolen from [tornado](https://github.com/tornadoweb/tornado/blob/master/tornado/log.py)

- Gunicorn aiohttp server for production use

- Integrated with static analysis and lint tools like `mypy`, `black`, `flake8` and git hook tool [`pre-commit`](https://pre-commit.com/#intro)

- Default [Github Actions](https://github.com/kigawas/flask-scaffold/actions) and [Heroku](https://scaffold-flask.herokuapp.com/) configuration

## Common tasks

### Create virtual environment with dependencies

    python3 -m venv .venv && source .venv/bin/activate && poetry install

### Run development flask server

    flask run --debug

### Run development gunicorn server with aiohttp worker

    gunicorn -b :5000 aioapp:aioapp -k aiohttp.worker.GunicornWebWorker --reload

### Run production gunicorn server

    ./boot.sh

### Build docker image

    docker build .

### Run with docker compose

    docker-compose up --build

### Run git pre-commit hooks

    pre-commit run --all-files