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.
37 Aug 07, 2022
216 Dec 26, 2022
53k Jan 02, 2023
1.6k Jan 09, 2023
3.7k Dec 30, 2022
122 Dec 22, 2022
1 Dec 07, 2021
72 Nov 30, 2022
16.7k Jan 08, 2023
927 Jan 08, 2023
74 Dec 30, 2022
37 Dec 17, 2022
8 Jun 16, 2022
552 Dec 30, 2022
1 Oct 22, 2021
3 Jul 01, 2021
2 Jan 04, 2022
27 Sep 08, 2022
264 Dec 31, 2022
4.3k Dec 31, 2022