Merge pull request #36 from web-push-libs/feat/35

Convert README from markdown to restructured text

Author: jrconlin

README.rst

@@ -0,0 +1,72 @@
+|Build\_Status| [|Requirements Status|]
+
+Webpush Data encryption library for Python
+==========================================
+
+This is a work in progress. This library is available on `pypi as
+pywebpush <https://pypi.python.org/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)
+
+.. |Build\_Status| image:: https://travis-ci.org/jrconlin/pywebpush.svg?branch=master
+   :target: https://travis-ci.org/jrconlin/pywebpush
+.. |Requirements Status| image:: https://requires.io/github/web-push-libs/pywebpush/requirements.svg?branch=master
+

convert_readme.sh

@@ -0,0 +1 @@
+ pandoc --from=markdown --to=rst --output README.rst README.md

pywebpush/__init__.py

@@ -198,7 +198,8 @@ def send(self, data, headers=None, ttl=0, gcm_key=None, reg_id=None):
             data['registration_ids'] = reg_ids
             data['raw_data'] = base64.b64encode(
                 encoded.get('body')).decode('utf8')
-            data['time_to_live'] = int(headers['ttl'] if 'ttl' in headers else ttl)
+            data['time_to_live'] = int(
+                headers['ttl'] if 'ttl' in headers else ttl)
             encoded_data = json.dumps(data)
             headers.update({
                 'Authorization': 'key='+gcm_key,

setup.py

@@ -3,7 +3,7 @@
 
 from setuptools import find_packages, setup
 
-__version__ = "0.6.1"
+__version__ = "0.6.2"
 
 
 def read_from(file):
@@ -19,7 +19,7 @@ def read_from(file):
 
 
 here = os.path.abspath(os.path.dirname(__file__))
-with io.open(os.path.join(here, 'README.md'), encoding='utf8') as f:
+with io.open(os.path.join(here, 'README.rst'), encoding='utf8') as f:
     README = f.read()
 with io.open(os.path.join(here, 'CHANGELOG.md'), encoding='utf8') as f:
     CHANGES = f.read()