https://github.com/livioribeiro/asgikit

ASGI Toolkit
https://github.com/livioribeiro/asgikit

asgi asyncio python toolkit web

Last synced: 5 days ago
JSON representation

ASGI Toolkit

• Host: GitHub
• URL: https://github.com/livioribeiro/asgikit
• Owner: livioribeiro
• License: mit
• Created: 2021-08-31T00:33:06.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-13T18:02:37.000Z (6 months ago)
• Last Synced: 2024-11-02T08:42:02.799Z (12 days ago)
• Topics: asgi, asyncio, python, toolkit, web
• Language: Python
• Homepage:
• Size: 141 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Asgikit - ASGI Toolkit

Asgikit is a toolkit for building asgi applications and frameworks.

It is intended to be a minimal library and provide the building blocks for other libraries.

The [examples directory](./examples) contain usage examples of several use cases

## Features:

- Request

  - Headers

  - Cookies

  - Body (bytes, str, json, stream)

  - Form

- Response

  - Plain text

  - Json

  - Streaming

  - File

- Websockets

## Request and Response

Asgikit `Request` and `Response` were designed to be have minimal interfaces,

so they only provide very few methods to read from the request and write to the response.

In particular, the `Response` works differently from most tools, in which you do not

return a response, but you write data into it.

It is provided several functions to interact with the request and the response, for instance,

to read form data from the request and write json to the response.

This strategy allows for simpler extensibility. For example, to parse json from the request

using an alternative json parser, you just need to write a function that reads the request.

Similarly, to write another data format into the response, you just write a function that

writes to the response.

## Custom JSON encoder and decoder

By default, asgikit uses `json.dumps` and `json.loads` for dealing with JSON. If

you want to use other libraries like `orjson`, just define the environment variable

`ASGIKIT_JSON_ENCODER` of the module compatible with `json`, or the full path to

the functions that perform encoding and decoding, in that order:

```dotenv

ASGIKIT_JSON_ENCODER=orjson

# or

ASGIKIT_JSON_ENCODER=msgspc.json.encode,msgspc.json.encode

```

## Example request and response

```python

from asgikit.requests import Request, read_json

from asgikit.responses import respond_json

async def main(scope, receive, send):

  request = Request(scope, receive, send)

  # request method

  method = request.method

  # request path

  path = request.path

  # request headers

  headers = request.headers

  # read body as json

  body_json = await read_json(request)

  data = {

    "lang": "Python",

    "async": True,

    "platform": "asgi",

    "method": method,

    "path": path,

    "headers": dict(headers.items()),

    "body": body_json,

  }

  # send json response

  await respond_json(request.response, data)

```

## Example websocket

```python

from asgikit.requests import Request

from asgikit.errors.websocket import WebSocketDisconnectError

async def app(scope, receive, send):

    request = Request(scope, receive, send)

    ws = request.websocket

    await ws.accept()

    while True:

        try:

            message = await ws.receive()

            await ws.send(message)

        except WebSocketDisconnectError:

            print("Client disconnect")

            break

```