History

linuskmr e45bf760b6 Add demo fastapi routes and models		2021-12-21 21:00:58 +01:00
..
src	Add demo fastapi routes and models	2021-12-21 21:00:58 +01:00
.gitignore	First structural change	2021-12-06 17:40:51 +01:00
README.md	Add demo fastapi routes and models	2021-12-21 21:00:58 +01:00
requirements.txt	Add demo fastapi routes and models	2021-12-21 21:00:58 +01:00

README.md

Juggl API

Installation

Minimum Python version: 3.10

Create virtual environment:

$ python3.10 -m venv/ ./venv/

Activate virtual environment (Linux):

$ source venv/bin/activate

Activate virtual environment (Windows):

$ .venv\Scripts\activate

Guidelines

All routes and should be async for maximum performance

Always specify the response_model in the route decorator and use the same type as type hint for the function return type. FastAPI is unfortunately not yet smart enough to determine the response_model from the return type hint. Maybe we should consider making a pull request...