Skip to main content

Talk realtime with groups

Project description

⭐ Nejma ⭐

Nejma ⭐ allows you to manage multiple realtime connections and send messages to groups or a user multiple tabs...

Take a look at this example nejma-chat, a simple chat application built using nejma and starlette.

Installation

$ pip install nejma

Getting started

Here's an example of using nejma with websockets.

First import Channel and channel_layer from nejma

from nejma import Channel, channel_layer

Create a channel on connect

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

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

Add groups, channels or send messages

    async def on_receive(self, websocket, data):
    	# Adds a channel to a giving group
        self.channel_layer.add(group, self.channel)

        # Removes a channel from a given group
        self.channel_layer.remove(group, self.channel)

        # Removes a channel from all the groups
        self.channel_layer.remove_channel(self.channel)

        # Reset all the groups
        self.channel_layer.flush()

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

Finnaly, remove the channel once the connection is closed

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

Starlette


To use nejma with starlette, simply import the WebSocketEndpoint from nejma

from channels.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

The ChannelLayer class provided by nejma exposes the following methods :

add(group, channel)

Adds a channel to a giving group.

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

remove(group, channel) Removes a channel from a given group

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

remove_channel(channel) Removes a channel from all the groups

self.channel_layer.remove_channel(self.channel)

flush() Reset all the groups

self.channel_layer.flush()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for nejma, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size nejma-0.1.0-py3-none-any.whl (5.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size nejma-0.1.0.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page