A simple Django package to integrate Web Push Notification in your Application
Project description
Django-Webpush
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
andVapid 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
{% webush_button %}
# For jinja templating engine
{{ webush_button() }}
</body>
Note: The Push Notification Button will show only if the user is logged in or any
group
named is passed throughwebpush
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 thewebpush
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
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
Release history Release notifications | RSS feed
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_webpush-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f38fe7522f097b45cb34450239b0520f46ccc2803da78c4c5e2218c4b967033b |
|
MD5 | 8d5895c1fbf886532a62b7d58c31bc77 |
|
BLAKE2b-256 | ef065a55199040a0cb8483840c37f74af1748553866146d8b0a6084b9399dd3c |