Skip to main content

Lightweight framework for quickly making socket consumers using Django and DjangoChannels.

Project description

Easy Channels

Lightweight framework for quickly making socket consumers using Django and DjangoChannels.


pip install django-easy-channels

Socket Example


from easy_channels import JSONConsumer

class ChatConsumer(JSONConsumer):
    # Socket connects
    def on_connect(self):
        # gets name from url = self.scope['url_route']['kwargs']['name']

        # Adds socket and consumer to group chatroom

        # Accepts socket connection

    # Called when consumer receives a message with the event broadcast_message
    def on_broadcast_message(self, event):
        payload = {
            'message': event['message'],

        # Sends this message to all connected sockets in the 'chatroom' group (not consumers)
        await self.group_send(
            'chatroom', # group
            'message', # event name
            payload # data


const messages = [];
const socket = new WebSocket("wss://YOUR_URL/chat/joselito");

// Called when socket receives a message
socket.onmessage = function (message) {
  switch (message.event) {
    case "message":
        message: message.message,
        from: message.from,

    event: "broadcast_message", // Calls "on_broadcast()" function in consumer
    message: "Hello World!", // Can be acessed in bachend using event['message']

Adding to Route

This JSONConsumer can be added to Django Channels route in the same way of the original consumers.

from django.urls import re_path

from .consumers import ChatConsumer

websocket_urlpatterns = [
    re_path(r'^ws/chat/(?P<name>\w+)/', consumers.ChatConsumer),

Communicating Between Consumers

Sometimes you want your consumers to talk with each other without sending data to the front end.

For example, we can make a consumer A notify a consumer B that it needs to update its frontend information without this confidental data passing through consumer A.

class ConsumerA(JSONConsumer):
    def on_connect(self):

    def on_notify(self):
        sensitive_data = get_some_data()

class ConsumerB(JSONConsumer):
    def on_connect(self):

    def on_some_event(self):
        # Calls 'on_notify()' in all consumers added to groupA

Middleware Example

You can create custom middlewares that will be run before the on_connect function or whenever a message is received.

The code below will automatically gather the chat user name from url.

from easy_channels.middleware import ConsumerMiddleware

class UserGatherMiddleware(ConsumerMiddleware):

    # Called before the consumer's 'on_connect()'
    def on_connect(self):
        # This middleware has complete access to the consumer in the self.consumer attribute = self.scope['url_route']['kwargs']['name']

To the middleware to work with the consumer we must pass it.

class ChatConsumer(JSONConsumer):
    middlewares = [UserGatherMiddleware]

    def on_connect(self):
        print( # Will print the user name

Project details

Download files

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

Source Distribution

django-easy-channels-0.0.1.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

django_easy_channels-0.0.1-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page