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.1.4

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.1.4.tar.gz (38.6 kB view details)

Uploaded Source

Built Distribution

xpresso-0.1.4-py3-none-any.whl (66.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xpresso-0.1.4.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.1.4.tar.gz
Algorithm Hash digest
SHA256 c1c4f3dee6d1a8582ca4263488b278628672d6926b027731a517854241ba4abf
MD5 21177a22c7983fa4827428dae858fc52
BLAKE2b-256 b752daa9f1009b69b6ba32f01b84401023256eb2b4c62519c0f49e21075bec74

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xpresso-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 66.2 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.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5bf99740188725f14c506aa910c9ec49c32910ef385645ebe2ebfbf8605b18d9
MD5 79c8eb1d668f504c1d3f757d1f4ebb2c
BLAKE2b-256 d5dbd33e7c8d76c7e3df8ed3a5eb14dc8b2d8fac0eb12eb9c779a5ebef8e93ca

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