Quart
Quart is an async Python web microframework. Using Quart you can,
- render and serve HTML templates,
- write (RESTful) JSON APIs,
- serve WebSockets,
- stream request and response data,
- do pretty much anything over the HTTP or WebSocket protocols.
Quickstart
Quart can be installed via pip,
$ pip install quart
and requires Python 3.7.0 or higher (see python version support for reasoning).
A minimal Quart example is,
from quart import Quart, render_template, websocket
app = Quart(__name__)
@app.route("/")
async def hello():
return await render_template("index.html")
@app.route("/api")
async def json():
return {"hello": "world"}
@app.websocket("/ws")
async def ws():
while True:
await websocket.send("hello")
await websocket.send_json({"hello": "world"})
if __name__ == "__main__":
app.run()
if the above is in a file called app.py it can be run as,
$ python app.py
To deploy this app in a production setting see the deployment documentation.
Contributing
Quart is developed on GitLab. If you come across an issue, or have a feature request please open an issue. If you want to contribute a fix or the feature-implementation please do (typo fixes welcome), by proposing a merge request.
Testing
The best way to test Quart is with Tox,
$ pip install tox
$ tox
this will check the code style and run the tests.
Help
The Quart documentation or cheatsheet are the best places to start, after that try searching stack overflow or ask for help on gitter. If you still can't find an answer please open an issue.
Relationship with Flask
Quart is an asyncio reimplementation of the popular Flask microframework API. This means that if you understand Flask you understand Quart.
Like Flask Quart has an ecosystem of extensions for more specific needs. In addition a number of the Flask extensions work with Quart.
Migrating from Flask
It should be possible to migrate to Quart from Flask by a find and replace of flask to quart and then adding async and await keywords. See the docs for more help.
137 Nov 3, 2022
11.4k Jan 9, 2023
3.4k Jan 3, 2023
1.5k Dec 28, 2022
1.9k Dec 31, 2022
153 Nov 9, 2022
211 Dec 17, 2022
70 Dec 22, 2022
52 Nov 9, 2022
150 Dec 14, 2022
7 Oct 13, 2021
14 Dec 23, 2022
13 Nov 29, 2022
1 Aug 29, 2022
2 Oct 11, 2021
2 Nov 4, 2021
2 Oct 13, 2022
2 Oct 5, 2022
2.6k Jan 3, 2023
15 May 7, 2022
5 Oct 27, 2022
1.2k Jan 2, 2023
5.3k Jan 2, 2023
6 Dec 12, 2022
4 Nov 23, 2021