nejma

Nejma

Inspiriert von channels ermöglicht NEJMA Sie, Nachrichten zu verwalten und an Kanäle zu senden

Dinge, die Sie mit nejma bauen können:

• Chat
• Benachrichtigung
• Verwandte Benutzer, die aus mehreren Registerkarten verbunden sind)
• Und mehr ...

Beispiel

Schauen Sie sich dieses Beispiel nejma-chat an, eine einfache Chat-Anwendung, die mit nejma und starlette erstellt wurde.

Installation

$ pip install nejma

Erste Schritte

Hier ist ein Beispiel für die Verwendung von nejma mit Websockets.

Erster importieren Kanal und Channel_Layer aus Nejma

 from nejma import Channel , channel_layer

Erstellen Sie einen Kanal auf Connect

 async def on_connect ( self , websocket , ** kwargs ):
    await super (). on_connect ( websocket , ** kwargs )

    self . channel = Channel ( send = websocket . send )

Fügen Sie Gruppen, Kanäle hinzu oder senden Sie Nachrichten

 async def on_receive ( self , websocket , data ):
    self . channel_layer . add ( group , self . channel )

    await self . channel_layer . group_send ( group , "Welcome !" )

Finnaly, entfernen Sie den Kanal, sobald die Verbindung geschlossen ist

 async def on_disconnect ( self , websocket , close_code ):
    self . channel_layer . remove_channel ( self . channel )

Starlette

---

Um nejma mit starlette zu verwenden, importieren Sie einfach den WebSocketendpoint aus Nejma

 from nejma . ext . starlette import WebSocketEndpoint

@ app . websocket_route ( "/ws" )
class Chat ( WebSocketEndpoint ):
    encoding = "json"

    async def on_receive ( self , websocket , data ):
        room_id = data [ 'room_id' ]
        message = data [ 'message' ]
        username = data [ 'username' ]

        if message . strip ():
            group = f"group_ { room_id } "

            self . channel_layer . add ( group , self . channel )

            payload = {
                "username" : username ,
                "message" : message ,
                "room_id" : room_id
            }
            await self . channel_layer . group_send ( group , payload )

Dokumente

Die von nejma bereitgestellte ChannelLayer -Klasse enthält die folgenden Methoden:

add(group, channel, send=None)

Fügt einer Spend -Gruppe einen Kanal hinzu.

• Senden: Methode zum Senden von Nachrichten an einen Kanal

 self . channel_layer . add ( group , self . channel , send = websocket . send )

async group_send(group, "Welcome !")

Sendet eine Nachricht an eine Gruppe von Kanälen

 await self . channel_layer . group_send ( group , "Welcome !" )

remove(group, channel)

Entfernt einen Kanal aus einer bestimmten Gruppe

 self . channel_layer . remove ( group , self . channel )

remove_channel(channel)

Entfernt einen Kanal aus allen Gruppen

 self . channel_layer . remove_channel ( self . channel )

flush()

Setzen Sie alle Gruppen zurück

 self . channel_layer . flush ()