chore: tag 1.13.0

This commit is contained in:
jrconlin 2021-03-16 07:51:54 -07:00
parent 336b1fb1ed
commit a2dbc6f0f1
No known key found for this signature in database
GPG Key ID: D2B33CD056ABD330
3 changed files with 68 additions and 65 deletions

View File

@ -1,5 +1,8 @@
# I am terrible at keeping this up-to-date.
## 1.13.0 (2021-03-15)
Support requests_session param in webpush fn too
## 1.12.0 (2021-03-15)
chore: library update, remove nose tests

View File

@ -10,7 +10,7 @@ available on `github <https://github.com/mozilla-services/pywebpush>`__.
Installation
------------
You'll need to run ``python virtualenv``. Then
Youll need to run ``python virtualenv``. Then
::
@ -34,14 +34,14 @@ 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 a
referenced to the user who requested it, and recall it when theres a
new push subscription update is left as an exercise for the reader.
Sending Data using ``webpush()`` One Call
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In many cases, your code will be sending a single message to many
recipients. There's a "One Call" function which will make things easier.
recipients. Theres a “One Call” function which will make things easier.
.. code:: python
@ -58,32 +58,32 @@ required and send it to the push server identified in the
**Parameters**
*subscription\_info* - The ``dict`` of the subscription info (described
*subscription_info* - The ``dict`` of the subscription info (described
above).
*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."``)
understand it. (e.g. ``data = "Mary had a little lamb."``)
*content\_type* - specifies the form of Encryption to use, either
*content_type* - specifies the form of Encryption to use, either
``'aes128gcm'`` or the deprecated ``'aesgcm'``. NOTE that not all User
Agents can decrypt ``'aesgcm'``, so the library defaults to the RFC 8188
standard form.
*vapid\_claims* - a ``dict`` containing the VAPID claims required for
*vapid_claims* - a ``dict`` containing the VAPID claims required for
authorization (See
`py\_vapid <https://github.com/web-push-libs/vapid/tree/master/python>`__
`py_vapid <https://github.com/web-push-libs/vapid/tree/master/python>`__
for more details). If ``aud`` is not specified, pywebpush will attempt
to auto-fill from the ``endpoint``.
*vapid\_private\_key* - Either a path to a VAPID EC2 private key PEM
file, or a string containing the DER representation. (See
`py\_vapid <https://github.com/web-push-libs/vapid/tree/master/python>`__
*vapid_private_key* - Either a path to a VAPID EC2 private key PEM file,
or a string containing the DER representation. (See
`py_vapid <https://github.com/web-push-libs/vapid/tree/master/python>`__
for more details.) The ``private_key`` may be a base64 encoded DER
formatted private key, or the path to an OpenSSL exported private key
file.
e.g. the output of:
e.g. the output of:
::
@ -145,13 +145,13 @@ Send the data using additional parameters. On error, returns a
*ttl* Message Time To Live on Push Server waiting for the client to
reconnect (in seconds)
*gcm\_key* Google Cloud Messaging key (if using the older GCM push
*gcm_key* Google Cloud Messaging key (if using the older GCM push
system) This is the API key obtained from the Google Developer Console.
*reg\_id* Google Cloud Messaging registration ID (will be extracted from
*reg_id* Google Cloud Messaging registration ID (will be extracted from
endpoint if not specified)
*content\_encoding* ECE content encoding type (defaults to "aes128gcm")
*content_encoding* ECE content encoding type (defaults to “aes128gcm”)
*curl* Do not execute the POST, but return as a ``curl`` command. This
will write the encrypted content to a local file named
@ -179,7 +179,7 @@ Encode the ``data`` for future use. On error, returns a
*data* Binary string of data to send
*content\_encoding* ECE content encoding type (defaults to "aes128gcm")
*content_encoding* ECE content encoding type (defaults to “aes128gcm”)
**Example**
@ -190,8 +190,8 @@ Encode the ``data`` for future use. On error, returns a
Stand Alone Webpush
-------------------
If you're not really into coding your own solution, there's also a
"stand-alone" ``pywebpush`` command in the ./bin directory.
If youre not really into coding your own solution, theres also a
“stand-alone” ``pywebpush`` command in the ./bin directory.
This uses two files: \* the *data* file, which contains the message to
send, in whatever form you like. \* the *subscription info* file, which
@ -207,7 +207,7 @@ like:
"p256dh": "aa02..."
}}
If you're interested in just testing your applications WebPush
If youre interested in just testing your applications WebPush
interface, you could use the Command Line:
.. code:: bash
@ -218,7 +218,7 @@ which will encrypt and send the contents of ``stuff_to_send.data``.
See ``./bin/pywebpush --help`` for available commands and options.
.. |Build Status| image:: https://travis-ci.org/web-push-libs/pywebpush.svg?branch=master
.. |Build Status| image:: https://travis-ci.org/web-push-libs/pywebpush.svg?branch=main
:target: https://travis-ci.org/web-push-libs/pywebpush
.. |Requirements Status| image:: https://requires.io/github/web-push-libs/pywebpush/requirements.svg?branch=master
:target: https://requires.io/github/web-push-libs/pywebpush/requirements/?branch=master
.. |Requirements Status| image:: https://requires.io/github/web-push-libs/pywebpush/requirements.svg?branch=main
:target: https://requires.io/github/web-push-libs/pywebpush/requirements/?branch=main

View File

@ -4,7 +4,7 @@ import os
from setuptools import find_packages, setup
__version__ = "1.12.0"
__version__ = "1.13.0"
def read_from(file):