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.
8 Jul 09, 2022
2.4k Jan 06, 2023
294 Jan 04, 2023
1 Jul 02, 2022
4 Nov 16, 2021
7 Nov 02, 2022
7 Dec 14, 2022
183 Nov 15, 2022
94 Nov 20, 2022
37 Dec 17, 2022
1.6k Dec 29, 2022
85 Dec 29, 2022
3.8k Jan 02, 2023
4.3k Dec 30, 2022
2 Jan 04, 2022
264 Dec 31, 2022
5.8k Dec 30, 2022
91 Nov 10, 2022
61.5k Jan 06, 2023
37 Aug 07, 2022