Skip to main content

A simple Django package to integrate Web Push Notification in your Application

Project description

Django-Webpush

Say Thanks!

Django-Webpush is a Package made for integrating and sending Web Push Notification in Django Application.

Currently, it Supports Sending Push Notification to Firefox 46+ and Chrome 52+.


Installation and Setup

You can install it easily from pypi by running

pip install django-webpush

After installing the package, add webpush in in your INSTALLED_APPS settings

INSTALLED_APPS = (
    ...
    'webpush',
)

If you would like to send notification to Google Chrome Users, you need to add a WEBPUSH_SETTINGS entry with the Vapid Credentials Like following:

WEBPUSH_SETTINGS = {
    "VAPID_PUBLIC_KEY": "Vapid Public Key",
    "VAPID_PRIVATE_KEY":"Vapid Private Key",
    "VAPID_ADMIN_EMAIL": "admin@example.com"
}

Replace "Vapid Public Key" and "Vapid Private Key" with your Vapid Keys. Also replace admin@example.com with your email so that the push server of browser can reach to you if anything goes wrong.

To know how to obtain Vapid Keys please see this py_vapid and Google Developer Documentation. You can obtain one easily from web-push-codelab.glitch.me. Application Server Keys and Vapid Keys both are same.

Then include webpush in the urls.py

urlpatterns =  [
    url(r'^webpush/', include('webpush.urls'))
]

django-webpush is shipped with built in jinja support. If you would like to use with jinja backend, pass pipeline.jinja2.PipelineExtension to your jinja environment. Like following:

{
    "BACKEND": "django_jinja.backend.Jinja2",
    "OPTIONS": {
      'extensions': ['webpush.jinja2.WebPushExtension'],
    }
},

Then run Migration by python manage.py migrate

Adding Web Push Information in Template

So in template, you need to load webpush_notifications custom template tag by following:

  • If you are using built in templating engine, add {% load webpush_notifications %} in the template
  • If you are using jinja templating engine, you do not need to load anything.

Next, inside the <head></head> tag add webpush_header according to your templating engine:

<head>
  # For django templating engine
  {% webpush_header %}
  # For jinja templating engine
  {{ webpush_header() }}
</head>

Next, inside the <body></body> tag, insert webush_button where you would like to see the Subscribe to Push Messaging Button. Like following

<body>
  <p> Hello World! </p>
  # For django templating engine
  {% webpush_button %}
  # For jinja templating engine
  {{ webpush_button() }}
</body>

Note: The Push Notification Button will show only if the user is logged in or any group named is passed through webpush context

If you would like to mark the subscription as a group, like all person subscribe for push notification from the template should be marked as group and would get same notification, you should pass a webpush context to the template through views. The webpush context should have a dictionary like {"group": group_name} . Like following

 webpush = {"group": group_name } # The group_name should be the name you would define.

return render(request, 'template.html',  {"webpush":webpush})

Note: If you dont pass group through the webpush context, only logged in users can see the button for subscription and able to get notification.


Sending Web Push Notification

A Web Push generally have a header and body. According to the W3C Specification, the data should be encrypted in transmission. The data is addressed as payload generally. Also a TTL header should be included indicating how much time the web push server store the data if the user is not online. So in order to send notification, see below.

  • If you would like to send notification to a specific group, do like following:

    from webpush import send_group_notification
    
    payload = {"head": "Welcome!", "body": "Hello World"}
    
    send_group_notification(group_name="my_group", payload=payload, ttl=1000)
    # All subscribe subscribe through "my_group" will get a web push notification.
    # A ttl of 1000 is passed so the web push server will store
    # the data maximum 1000 seconds if any user is not online
    
  • If you would like to send Notification to a specific user, do like following

    from webpush import send_user_notification
    
    payload = {"head": "Welcome!", "body": "Hello World"}
    
    send_user_notification(user=user, payload=payload, ttl=1000)
    # Here in the user parameter, a user object should be passed
    # The user will get notification to all of his subscribed browser. A user can subscribe many browsers.
    

    And the subscribers will get a notification like:

Web Push Notification

  • If you notification should have an icon or open a url when clicked, you can add those to the payload:

    from webpush import send_user_notification
    
    from webpush import send_group_notification
    
    payload = {"head": "Welcome!", "body”: "Hello World", 
               "icon": "https://i.imgur.com/dRDxiCQ.png“, "url": "https://www.example.com"}
    
    send_group_notification(group_name="my_group", payload=payload, ttl=1000)
    

And the subscribers will get a notification like:

Web Push Notification icon

That will open https://www.example.com if clicked.

  • If you want fine grained control over sending a single push message, do like following

    from webpush import WebPushException, send_single_notification
    
    payload = {"head": "Welcome!", "body": "Hello World"}
    
    user = request.user
    push_infos = user.webpush_info.select_related("subscription")
    for push_info in push_infos:
        try:
            send_single_notification(push_info.subscription, payload)
    
        except WebPushException as ex:
            extra = {"subscription": push_info.subscription, "exception": ex}
            log.error("Sending Push notification failed.", extra=extra)
            if "<Response [410]>" in str(ex):
                # 410 = Endpoint Not Valid
                # remove subscription
                push_info.subscription.delete()
    

And the subscribers will get a notification like Web Push Notification

License


Copyright © 2018 Safwan Rahman

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_webpush-0.2.7-py2-none-any.whl (16.4 kB) Copy SHA256 hash SHA256 Wheel py2 Sep 22, 2018
django_webpush-0.2.7-py3-none-any.whl (16.4 kB) Copy SHA256 hash SHA256 Wheel py3 Sep 22, 2018
django-webpush-0.2.7.tar.gz (26.8 kB) Copy SHA256 hash SHA256 Source None Sep 22, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page