Skip to main content

A Django package to handle notifications using Django Channels and WebSockets.

Project description

A Django application to deliver user notifications made with django-snitch using WebSockets.

https://travis-ci.org/marcosgabarda/django-websocket-notifications.svg?branch=master https://img.shields.io/badge/code_style-black-000000.svg

Quick start

This applications works using django-channels, so, you need to integrate this with your project before to integrate django-websocket-notifications. So, to make the quick start as quick and simple as possible, we’ve made the following assumptions:

  • You already have integrated django-channels

  • You are using a channel layer, like Redis

  • You have a routing.py file

  • Your project uses DRF to deliver a RESTful API

1 Install using pip:

pip install django-websocket-notifications

2 Add “websocket_notifications” to your INSTALLED_APPS settings like this:

INSTALLED_APPS += ('websocket_notifications',)

3 Add the routing patterns to your routing.py file:

from channels.auth import AuthMiddlewareStack
from channels.routing import ProtocolTypeRouter, URLRouter
from websocket_notifications.routing import websocket_urlpatterns


application = ProtocolTypeRouter(
    {"websocket": AuthMiddlewareStack(URLRouter(websocket_urlpatterns)),}
)

4 (Optional) In order to test the integration, you can add the following view to your urls.py file to be able to access to a testing view:

urlpatterns += [
    path(
        "websocket-notifications/",
        include(
            "websocket_notifications.urls",
            namespace="websocket_notifications",
        ),
    ),
]

Now, you can access to /websocket-notifications/listener/ to check the integration.

5 Add the ViewSet to the DRF router:

from websocket_notifications.api.rest_framework import NotificationGroupViewSet


router = routers.DefaultRouter()
router.register("websocket-notifications/groups", viewset=NotificationGroupViewSet)

6 Integrate with django-snitch:

from websocket_notifications.snitch.backends import WebSocketNotificationBackend


@snitch.register(EVENT)
class MyEventHandler(snitch.EventHandler):
    ephemeral = True
    notification_backends = [WebSocketNotificationBackend]

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-websocket-notifications-1.2.0.tar.gz (8.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page