Welcome to asgi-tools’s documentation!

ASGI-Tools – Is a really lightweight ASGI Toolkit to build ASGI applications faster.

The Features:

• All popular async python libraries are supported (Asyncio, Trio, Curio);

• Competitive Performance;

• HTTP Headers/Cookies/Form data support (Request);

• HTTP (Response), Static files (ResponseFile), Streaming (ResponseStream) responses;

• WebSockets (ResponseWebSocket) and SSE (server side events ResponseSSE) support;

• ASGI Lifespan support (LifespanMiddleware) with startup and shutdown events;

• ASGI Routing support (RouterMiddleware) to route your handlers by http urls;

• Auto parsing for app responses (ResponseMiddleware);

• Test client (ASGITestClient) to test ASGI applications;

• And more

Welcome to the documentation. Get started with Installation and then get an overview with the Usage. The rest of the docs describe each component of asgi_tools in detail, with a full reference in the API Reference section.

User’s Guide

• Installation
  • Python Version
  • Dependencies
  • Install ASGI-Tools
• Usage
  • ASGI Application
  • The Request Object
  • Routing
  • Dynamic URLs
  • Static Files
  • Redirects and Errors
  • About Responses
  • Middlewares
  • Nested applications

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API Reference
  • Request
    • Request
      • Request.headers
      • Request.cookies
      • Request.query
      • Request.charset
      • Request.content_type
      • Request.url
      • Request.stream()
      • Request.body()
      • Request.text()
      • Request.form()
      • Request.json()
      • Request.data()
  • Responses
    • Response
      • Response.headers
      • Response.cookies
      • Response.__call__()
    • ResponseText
      • ResponseText
    • ResponseHTML
      • ResponseHTML
    • ResponseJSON
      • ResponseJSON
    • ResponseRedirect
      • ResponseRedirect
    • ResponseError
      • ResponseError
    • ResponseStream
      • ResponseStream
    • ResponseSSE
      • ResponseSSE
    • ResponseFile
      • ResponseFile
    • ResponseWebSocket
      • ResponseWebSocket
  • Middlewares
    • RequestMiddleware
      • RequestMiddleware
    • ResponseMiddleware
      • ResponseMiddleware
    • LifespanMiddleware
      • LifespanMiddleware
    • RouterMiddleware
      • RouterMiddleware
    • StaticFilesMiddleware
      • StaticFilesMiddleware
    • BackgroundMiddleware
      • BackgroundMiddleware
  • Application
    • App
      • App.route()
      • App.on_startup()
      • App.on_shutdown()
      • App.on_error()
      • App.middleware()
  • Class Based Views
    • HTTPView
  • TestClient
    • ASGITestClient
      • ASGITestClient.request()
      • ASGITestClient.websocket()
      • ASGITestClient.lifespan()

Indices and tables

• Index

• Module Index

• Search Page