djnotifier 1.0.1

A web-based Django app to conduct real time notification.

djnotifier

djnotifier is a Django app to conduct web-based real time notification. Almost fully customizable app + plugin.

Quick start

Guide to setup djnotifier into your Django project

Requirements

1. System requirements: Redis server
2. pip3 packages -

   channels
   channels-redis
   

   and off course django itself.

Install and configure

Step-0

pip install djnotifier

Step-1

Add djnotifier to your INSTALLED_APPS setting like this

INSTALLED_APPS = [
    ...
    'djnotifier',
]

Step-2

Setup asgi application for the project

1. Update asgi.py

   # <project>/asgi.py
   import os
   
   from django.core.asgi import get_asgi_application
   from channels.auth import AuthMiddlewareStack
   from channels.routing import ProtocolTypeRouter, URLRouter
   
   # import web-socket routes from djnotifier
   from djnotifier.routing import websocket_urlpatterns
   
   os.environ.setdefault('DJANGO_SETTINGS_MODULE', '<project_name>.settings')
   
   application = ProtocolTypeRouter({
       "http": get_asgi_application(),
       "websocket": AuthMiddlewareStack(
           URLRouter(
               websocket_urlpatterns
           )
       ),
   })
   

2. Configure asgi application in settings

   # <project>/config.py
   ...
   ASGI_APPLICATION = '<project>.asgi.application'
   

Step-3

Configure redis layer

# <project>/config.py
...

CHANNEL_LAYERS = {
   'default': {
      'BACKEND': 'channels_redis.core.RedisChannelLayer',
      'CONFIG': {
       "hosts": [('127.0.0.1', 6379)],
      },
   },
}

...

Step-4

Add djnotifier's template to a common project template e.g. base.html or core.html

<!--templates/core.html-->
{% include 'djnotifier/dj_notifier.html' %}

Usage example

Configure djnotifier

# <project>/settings.py

...

# You may replace this consumer as needed and 
# point the consumer class
DJ_NOTIFIER_CONSUMER = 'djnotifier.consumers.DJNotifierConsumer'

# If you want to register more websocket routes
# you may point to the routes list variable as - 
DJ_NOTIFIER_EXTRA_ROUTES = "<app_label>.routing.extra_routes"

# When you're developing you may want to 
# turn it on by putting `True` to see
# `djnotifier` logs
DJ_NOTIFIER_CONFIG_INFO_SHOW = False

Copy example project into your Django project's root, install in your INSTALLED_APPS

INSTALLED_APPS = [
     ...
     'djnotifier',
     'example',
 ]

Add example routes to project's url

# <project>/urls.py
...
from django.urls import path, include
...

urlpatterns = [
    ...
    path("example/", include('example.urls')),
    ...
]

Now run redis-server and django development server -

# run redis-server
$  redis-server

in another terminal/console tab run -

# run django dev server
$ python manage.py runserver

Now open 2 tabs -

1. Un-authenticated user page: http://localhost:8000/example/
2. Authenticated user page: http://localhost:8000/example/auth/

Now in another tab if you open http://localhost:8000/example/notify/ then you'll see two different notification.

Documentation

Full documentation here...