nejma

Nejma

Inspiré par channels , Nejma vous permet de gérer et d'envoyer des messages à des groupes de canaux

Des choses que vous pouvez construire avec nejma :

• chat
• notification
• gérer les utilisateurs connectés à partir de plusieurs onglets)
• Et plus ...

Exemple

Jetez un œil à cet exemple nejma-chat , une application de chat simple construite à l'aide de nejma et starlette .

Installation

$ pip install nejma

Commencer

Voici un exemple d'utilisation de nejma avec WebSockets.

First Import Channel et Channel_layer depuis Nejma

 from nejma import Channel , channel_layer

Créer un canal sur Connect

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

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

Ajouter des groupes, des canaux ou envoyer des messages

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

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

Finnaly, retirez le canal une fois la connexion fermée

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

Starlette

---

Pour utiliser nejma avec starlette , importez simplement le point WebSocket de 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 )

Docs

La classe ChannelLayer fournie par nejma expose les méthodes suivantes:

add(group, channel, send=None)

Ajoute un canal à un groupe de dons.

• Envoyer: méthode pour envoyer des messages à un canal

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

async group_send(group, "Welcome !")

Envoie un message à un groupe de canaux

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

remove(group, channel)

Supprime un canal d'un groupe donné

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

remove_channel(channel)

Supprime un canal de tous les groupes

 self . channel_layer . remove_channel ( self . channel )

flush()

Réinitialisez tous les groupes

 self . channel_layer . flush ()