flask-jeroboam 0.0.1a0

Bringing FastAPI Developer experience to Flask.

Flask-Jeroboam

Project Description

Flask-Jeroboam is a thin layer on top of Flask to make request parsing, response serialization and auto-documentation as smooth and easy as in FastAPI.

Motivation

FastAPI has been rapidly gaining ground in Python Web Development since its inception in late 2018 (1). Besides impressive performance improvement , it brings a very compelling API for request parsing and response serialisation that speed up API development by catering for Developer Experience.

While it is often compared to Flask, (1, 2 and 3), the comparaison feels a bit unfair. FastAPI is, in the words of its creator@tiangolo a thin layer on top of Starlette, a lightweight ASGI framework/toolkit, ... for building async web services in Python and Pydantic. To some extend, Flask is more related to Starlette than it is to FastAPI.

Although there are some excellent Flask extensions dealing with request parsing, response serialisation, and auto-documentation, I wanted something closer to FastAPI's DX. Hence Flask - Jeroboam.

Who is it inteded for

For devs who are fond of FastAPI but have perfectly good reasons to stick to Flask, including:

• a large code base build with Flask (although migration could be undertaken)
• being confortable with Flask and not needing the performance of Starlette
• depending on Flask eco-system

Features

Flask-Jeroboam will provide the following features :

• OpenAPI Auto-Documentation based on endpoint type annotations
• Request parsing with pydantic
• Response serialization facilitation with pydantic

Dependency Injection as featured in FastAPI feels like something you don't need in Flask.

Installation

You can install flask-jeroboam via pip, or [poetry] from PyPI:

$ pip install flask-jeroboam

or better yet with poetry:

$ poetry add flask-jeroboam

Example Usage

Our goal is to implement an API similar, if not equivalent, to the one you have with FastAPI. Because we think it's an excellent standard.

First you would need to replace your existing flask.Blueprint with a flask-jeroboam.ApiBlueprint. Note that APIBlueprint are just regular Blueprint with a extra features, but they should not break any endpoint defined the flask way.

from flask-jeroboam import APIBlueprint

router = APIBlueprint("wines", __name__)

@router.get("/wines", response_model=serializers.WineList)
@jwt_required()
def read_example(wines_in: parsers.WineList):
    wines = crud.get_wines(wines_in, db.session)
    return {"items": wines}

License

Distributed under the terms of the MIT license, Flask-Jeroboam is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

The main inspiration of this project comes from @tiangolo's FastAPI.

The heavy-lifting if performed by Flask and pydantic.

The project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.