Skip to main content

A developer centric, performant Python web framework

Project description

Xpresso

Test Coverage Package version Supported Python versions

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:

Swagger UI

For more examples, tutorials and reference materials, see our documentation.

See this release on GitHub: v0.2.1

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xpresso-0.2.1.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

xpresso-0.2.1-py3-none-any.whl (66.1 kB view details)

Uploaded Python 3

File details

Details for the file xpresso-0.2.1.tar.gz.

File metadata

  • Download URL: xpresso-0.2.1.tar.gz
  • Upload date:
  • Size: 38.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Linux/5.11.0-1025-azure

File hashes

Hashes for xpresso-0.2.1.tar.gz
Algorithm Hash digest
SHA256 a0fcebefdc6c81b8330f92c1bae062d51678ce7f8b147ee404845a207881fd0c
MD5 bbdd028cd901574ad620264d8a9f4d15
BLAKE2b-256 ed2249dd3c4e4d153471ecb63014da0e0ae72c65ee3f8d2155bd0e59a7878208

See more details on using hashes here.

File details

Details for the file xpresso-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: xpresso-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 66.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Linux/5.11.0-1025-azure

File hashes

Hashes for xpresso-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f7a6e4272e7bb53709276884bcf2d07950e11b1b1883218067ebc67c756ebe02
MD5 b927959ce52da415f1627f4d0d601721
BLAKE2b-256 38689e1194b5faeade8811702bfdd92cc05c8941f24f499496cb732d182debd1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page