Flask Sugar is a web framework for building APIs with Flask, Pydantic and Python 3.6+ type hints.
Project description
Flask Sugar
Flask Sugar is a web framework for building APIs with Flask, Pydantic and Python 3.6+ type hints.
check parameters and generate API documents automatically
Documentation: https://shangsky.github.io/flask-sugar
Source Code: https://github.com/shangsky/flask-sugar
Requirements
- Python 3.6+
- Flask 2.0+
Installation
$ pip install flask-sugar
A Simple Example
# save this as main.py
from typing import Any
from flask_sugar import Sugar
from typing_extensions import TypedDict
app = Sugar(__name__)
class Resp(TypedDict):
code: int
msg: str
data: Any
@app.get("/")
def index() -> Resp:
"""index page"""
return {"code": 0, "msg": "success", "data": {}}
$ export FLASK_APP=main:app
$ flask run --reload
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
Now visit the API documentation with Swagger UI at http://localhost:5000/doc:
visit the API documentation with Redoc at http://localhost:5000/redoc:
License
This project is licensed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flask-sugar-0.0.5.tar.gz
(11.0 kB
view hashes)
Built Distribution
Close
Hashes for flask_sugar-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5471b38b0334615a910b2e093485e5bcbac351aacfb6ca8aacd96693b6d4ad6c |
|
MD5 | 548a5da3018ca13707b7847ba591ec36 |
|
BLAKE2b-256 | 9a501bad91ec41771c510aaeff3f5d15c6fcc829c4c57de198f0f82c08bb256d |