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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0c53b5e38d70b71874770d09ee7eb9c6e1802e60676f00cd5b1897d2a2ba98b |
|
MD5 | 04b6bb6712973cf25e2ed6b76ed20b26 |
|
BLAKE2b-256 | f3236adca16252fc8509b34c339e57d136a3057d965cddc28ad1e77cc3f73326 |
Hashes for django_websocket_notifications-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b316d4ea7a0c59e8a4955fd532798cda9a1b873ecd3bffb35603feba5d610504 |
|
MD5 | e8493c6d2538ed42b7197a3f66b77d13 |
|
BLAKE2b-256 | ae6fad65161cf2dbe5466aa8629b18468346571d509bc07e18e769bcd92d6233 |