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.
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
Built Distribution
Hashes for django-websocket-notifications-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b01be882f572c39d4bfa333ea277dc399642df6d6945be5ff76c5405f5b7749c |
|
MD5 | 75fe5de45eb71040447a23f04ea29f78 |
|
BLAKE2b-256 | e4af2a21e33a1d4cd81a3ad6df1c187d44e29a734526e223ed74232fbe463560 |
Hashes for django_websocket_notifications-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7836fcb17411070a911d56a093701f49e521163c8f4004a27906eb4c58912dea |
|
MD5 | e079af88e105dd15cfefad68ce21b4f7 |
|
BLAKE2b-256 | ab8a998ffa688661f01d86068b1a1a8fabcc188c9c62f789f7e1435c55d41e37 |