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.
10 Jan 25, 2022
53k Jan 02, 2023
64 Dec 09, 2022
91 Nov 10, 2022
11 Jun 03, 2022
3 Jul 01, 2021
7 Dec 14, 2022
4 May 13, 2021
26 Sep 11, 2022
32 Dec 24, 2022
3 Jun 13, 2022
8 Dec 16, 2021
6.2k Jan 01, 2023
1 Jul 02, 2022
9 Feb 04, 2022
927 Jan 08, 2023
8 Jul 09, 2022
705 Jan 04, 2023
13 Aug 31, 2022
294 Jan 04, 2023