Introduction
xpresso is an ASGI web framework built on top of Starlette, Pydantic and di, with heavy inspiration from FastAPI.
Some of the standout features are:
- ASGI support for high performance (within the context of Python web frameworks)
- OpenAPI documentation generation
- Automatic parsing and validation of request bodies and parameters, with hooks for custom extractors
- Full support for OpenAPI parameter serialization
- Highly typed and tested codebase with great IDE support
- A powerful dependency injection system, backed by di
Requirements
Python 3.7+
Installation
pip install xpresso
You'll also want to install an ASGI server, such as Uvicorn.
pip install uvicorn
Example
Create a file named example.py:
from pydantic import BaseModel
from xpresso import App, Path, FromPath, FromQuery
class Item(BaseModel):
item_id: int
name: str
async def read_item(item_id: FromPath[int], name: FromQuery[str]) -> Item:
return Item(item_id=item_id, name=name)
app = App(
routes=[
Path(
"/items/{item_id}",
get=read_item,
)
]
)
Run the application:
uvicorn example:app
Navigate to http://127.0.0.1:8000/items/123?name=foobarbaz in your browser. You will get the following JSON response:
{"item_id":123,"name":"foobarbaz"}
Now navigate to http://127.0.0.1:8000/docs to poke around the interactive Swagger UI documentation:
For more examples, tutorials and reference materials, see our documentation.
705 Jan 04, 2023
3.7k Dec 30, 2022
53k Jan 02, 2023
2 Dec 02, 2021
0 Mar 05, 2022
6 Aug 02, 2022
17 Oct 18, 2022
2 Dec 03, 2021
1 Dec 07, 2021
1 Nov 16, 2021
8 Jul 09, 2022
32 Dec 14, 2022
796 Dec 26, 2022
29 Nov 20, 2022
46 Nov 08, 2022
814 Jan 08, 2023
4 Dec 21, 2022
3 Apr 12, 2022
16.7k Jan 08, 2023
46 Nov 12, 2022