xraptor 0.1.2b0

Fast as websocket easy as http

X-raptor

By: CenturyBoys

⚠️ Fast as a hell, CAUTION!!!

This package is being developed and is in the testing process. 🚨 NOT USE THIS PACKAGE IN PRODUCTION !!!

Fast as websocket easy as http, this package is an abstraction of websockets package to allow user to register get, post, sub, unsub asynchronous callbacks. For this all message must be a requests or a response object.

import xraptor

_xraptor = xraptor.XRaptor("localhost", 8765)

@_xraptor.register("/send_message_to_chat_room").as_post
async def send_message(
        request: xraptor.Request
) -> xraptor.Response:
    ...
    return xraptor.Response(
        request_id=request.request_id,
        header={},
        payload='{"message": "Message sent"}'
    )

To allow multiple asynchronous responses on sub routes X-raptor use the request_id as antenna. Those antennas are pubsub channels that yield string messages

Antenna

There is no default antenna configuration, you have two options implements your own antenna class using the interface or use one of the extra packages.

from abc import ABC, abstractmethod
from typing import AsyncIterator, Awaitable

class Antenna(ABC):

    @abstractmethod
    def subscribe(self, key: str) -> AsyncIterator[str]:
        """
        async generator that will yield message from the key's channel 
        :param key: pubsub channel
        :return: str message async generator
        """
        pass

    @abstractmethod
    def post(self, key: str, message: str) -> Awaitable:
        """
        async function that will publish a message to a key's channel 
        :param key: pubsub channel
        :param message: message
        :return: 
        """
        pass

Extras

Redis

This extra add the redis package in version ^5.0.8.

How to install extra packages?

poetry add xraptor -E redis_edition
OR
pip install 'xraptor[redis_edition]'

You need pass the X_RAPTOR_REDIS_URL parameter on configuration

Full Example

A very simple chat implementation was created to test sub, poss and unsub routes.

The test work using the redis_edition and a singleton package called meeseeks-singleton (to install you can add the extra package test).

• The server.py implementation can be found here.
• The chat_room.py implementation can be found here.
• The client.py implementation can be found here.