WebPush publication library
Project description
[](https://travis-ci.org/jrconlin/pywebpush)
# Webpush Data encryption library for Python
This is a work in progress.
This library is available on [pypi as
pywebpush](https://pypi-hypernode.com/pypi/pywebpush).
Source is available on [github](https://github.com/jrconlin/pywebpush)
## Installation
You'll need to run `python virtualenv`.
Then
```
bin/pip install -r requirements.txt
bin/python setup.py develop
```
## Usage
In the browser, the promise handler for
[registration.pushManager.subscribe()](https://developer.mozilla.org/en-US/docs/Web/API/PushManager/subscribe)
returns a
[PushSubscription](https://developer.mozilla.org/en-US/docs/Web/API/PushSubscription)
object. This object has a .toJSON() method that will return a JSON
object that contains all the info we need to encrypt and push data.
As illustration, a subscription info object may look like:
```
{"endpoint": "https://updates.push.services.mozilla.com/push/v1/gAA...", "keys": {"auth": "k8J...", "p256dh": "BOr..."}}
```
How you send the PushSubscription data to your backend, store it
referenced to the user who requested it, and recall it when there's
new a new push subscription update is left as an excerise for the
reader.
The data can be any serial content (string, bit array, serialized
JSON, etc), but be sure that your receiving application is able to
parse and understand it. (e.g. `data = "Mary had a little lamb."`)
gcm_key is the API key obtained from the Google Developer Console.
It is only needed if endpoint is
https://android.googleapis.com/gcm/send
`headers` is a `dict`ionary of additional HTTP header values (e.g.
[VAPID](https://github.com/mozilla-services/vapid/tree/master/python)
self identification headers). It is optional and may be omitted.
to send:
```
WebPusher(subscription_info).send(data, headers)
```
to send for Chrome:
```
WebPusher(subscription_info).send(data, headers, ttl, gcm_key)
```
You can also simply encode the data to send later by calling
```
encoded = WebPush(subscription_info).encode(data)
```
## 0.4.0 (2016-06-05)
feat: make python 2.7 / 3.5 polyglot
## 0.3.4 (2016-05-17)
bug: make header keys case insenstive
## 0.3.3 (2016-05-17)
bug: force key string encoding to utf8
## 0.3.2 (2016-04-28)
bug: fix setup.py issues
## 0.3 (2016-04-27)
feat: added travis, normalized directories
## 0.2 (2016-04-27)
feat: Added tests, restructured code
## 0.1 (2016-04-25)
Initial release
# Webpush Data encryption library for Python
This is a work in progress.
This library is available on [pypi as
pywebpush](https://pypi-hypernode.com/pypi/pywebpush).
Source is available on [github](https://github.com/jrconlin/pywebpush)
## Installation
You'll need to run `python virtualenv`.
Then
```
bin/pip install -r requirements.txt
bin/python setup.py develop
```
## Usage
In the browser, the promise handler for
[registration.pushManager.subscribe()](https://developer.mozilla.org/en-US/docs/Web/API/PushManager/subscribe)
returns a
[PushSubscription](https://developer.mozilla.org/en-US/docs/Web/API/PushSubscription)
object. This object has a .toJSON() method that will return a JSON
object that contains all the info we need to encrypt and push data.
As illustration, a subscription info object may look like:
```
{"endpoint": "https://updates.push.services.mozilla.com/push/v1/gAA...", "keys": {"auth": "k8J...", "p256dh": "BOr..."}}
```
How you send the PushSubscription data to your backend, store it
referenced to the user who requested it, and recall it when there's
new a new push subscription update is left as an excerise for the
reader.
The data can be any serial content (string, bit array, serialized
JSON, etc), but be sure that your receiving application is able to
parse and understand it. (e.g. `data = "Mary had a little lamb."`)
gcm_key is the API key obtained from the Google Developer Console.
It is only needed if endpoint is
https://android.googleapis.com/gcm/send
`headers` is a `dict`ionary of additional HTTP header values (e.g.
[VAPID](https://github.com/mozilla-services/vapid/tree/master/python)
self identification headers). It is optional and may be omitted.
to send:
```
WebPusher(subscription_info).send(data, headers)
```
to send for Chrome:
```
WebPusher(subscription_info).send(data, headers, ttl, gcm_key)
```
You can also simply encode the data to send later by calling
```
encoded = WebPush(subscription_info).encode(data)
```
## 0.4.0 (2016-06-05)
feat: make python 2.7 / 3.5 polyglot
## 0.3.4 (2016-05-17)
bug: make header keys case insenstive
## 0.3.3 (2016-05-17)
bug: force key string encoding to utf8
## 0.3.2 (2016-04-28)
bug: fix setup.py issues
## 0.3 (2016-04-27)
feat: added travis, normalized directories
## 0.2 (2016-04-27)
feat: Added tests, restructured code
## 0.1 (2016-04-25)
Initial release
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
pywebpush-0.6.1.tar.gz
(11.8 kB
view details)
File details
Details for the file pywebpush-0.6.1.tar.gz.
File metadata
- Download URL: pywebpush-0.6.1.tar.gz
- Upload date:
- Size: 11.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d2551ad3ad1cbd63d815f728b580249ace9f421ed6f9b0b22a66267423be0451 |
|
| MD5 | b395888b4f54f36489acbcc3b2385761 |
|
| BLAKE2b-256 | 1eaa51c1a32212d929cd637c2ed020a52ff1979d1bf0e62560f36d3c9103ac51 |
