Code Monkey home page Code Monkey logo

pywebpush's Introduction

Build_Status

Webpush Data encryption library for Python

This is a work in progress.

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() returns a 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 dictionary of additional HTTP header values (e.g. VAPID 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)

pywebpush's People

Contributors

jrconlin avatar kamotos avatar natim avatar safwanrahman avatar ujjawal-garg avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.