Skip to main content

Simple one-way bindings for django-channels with some specific support for django-rest-framework serializers and websockets. I.e. enrich your existing API with push notifications.

Project description

DRF channels one-way WS

Simple one-way bindings for django-channels with some specific support for django-rest-framework serializers and websockets. I.e. enrich your existing API with push notifications.

Installation

  • pipenv install drf-channels-oneway-ws or pip install drf-channels-oneway-ws

Usage

Bindings

from django.db import models
from rest_framework import serializers
from channels_oneway.bindings import Binding

class Family(models.Model):
    name = models.CharField(max_length=255)

class Bird(models.Model):
    name = models.CharField(max_length=255)
    family = models.ForeignKey('Family', models.CASCADE)


class BirdSerializer(serializers.ModelSerializer):
    class Meta:
        model = Customer
        fields = ('__all__')


class BirdBinding(Binding):
    model = Bird
    stream = 'birds'
    serializer = BirdSerializer

    @classmethod
    def group_names(cls, instance):
        return [instance.family.name]

class FamilyBinding(Binding):
    """
    example of a binding not using a drf serializer
    """
    model = Family
    stream = 'bird-families'

    @classmethod
    def group_names(cls, instance):
        return [instance.name]

    def serialize_data(self, instance):
        return {'id': instance.id, 'name': instance.name}

Now you make sure you have a WebsocketConsumer, which does something like self.channel_layer.group_add('thrushes', self.channel_name) in its connect coroutine. Family.objects.create(name='thrushes') will then cause the following to be sent over the associated websocket:

{
    "stream": "bird-families",
    "payload": {
        "action": "create",
        "data": {"id": 1, "name": "thrushes"},
        "model": "your_app.family",
        "pk": 1
    }
}

Upon modification ("action": "update") or deletion ("action": "delete") you will receive messages with an equal structure.

Helpers

In order to send a ws message from outside a binding, but using the same format (stream + payload) (and also the drf json encoder) use the async channels_oneway.utils.groupSend(group, stream, payload) or its sync equivalent groupSendSync.

Contributing

Installation

  • git clone git@github.com:evocount/drf-channels-oneway-ws.git
  • cd python-set-ings
  • pipenv install --dev

Running tests

  • pipenv run pytest --cov

License

This project is licensed under the MIT License.

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 drf-channels-oneway-ws, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size drf_channels_oneway_ws-0.1.0-py2.py3-none-any.whl (6.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size drf-channels-oneway-ws-0.1.0.tar.gz (6.0 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