asgi-tools 2.1.1

ASGI Toolkit to build web applications

asgi-tools is a lightweight ASGI toolkit for building ASGI applications faster.

---

Documentation is here: https://klen.github.io/asgi-tools

ASGI-Tools is designed to be used as an ASGI Toolkit to quickly build really lightweight ASGI applications/middlewares/tools.

For instance these middlewares were built with the library:

• ASGI-Sessions

• ASGI-Babel

• ASGI-Prometheus

Features:

• Supports the most popular async Python libraries: Asyncio, Trio, and Curio

• Request – Parse ASGI scope, get url, headers, cookies, read a request’s data/json/form-data

• Response – Send HTTP (text, html, json, stream, sse, file, http errors) responses

• ResponseWebSocket – Work with websockets

• RequestMiddleware – Parse a scope and insert the parsed request into the scope

• ResponseMiddleware – Parse responses and convert them into ASGI messages

• RouterMiddleware – Route HTTP requests

• LifespanMiddleware – Process a lifespan cycle

• StaticFilesMiddleware – Serve static files from URL prefixes

• asgi_tools.tests.TestClient – A test client with websockets support to test asgi applications

• App – A simple foundation for ASGI apps

Contents

• Requirements

• Installation

• A Quick Example

• Bug tracker

• Contributing

• License

Requirements

• python >= 3.10

Note

pypy3 is also supported

ASGI-Tools belongs to the category of ASGI web frameworks, so it requires an ASGI HTTP server to run, such as uvicorn, daphne, or hypercorn.

Installation

asgi-tools should be installed using pip:

pip install asgi-tools

A Quick Example

You can use any of ASGI-Tools components independently.

ASGI-Tools also includes an App helper to quickly build ASGI applications. For instance:

Save this to app.py.

from asgi_tools import App

app = App()

@app.route('/')
async def hello(request):
    return "Hello World!"

Run it with uvicorn

$ uvicorn app:app

Bug tracker

If you have any suggestions, bug reports, or annoyances, please report them to the issue tracker at https://github.com/klen/asgi-tools/issues

Contributing

Development of the project happens at: https://github.com/klen/asgi-tools

License

Licensed under a MIT license.