pushjack
|version| |travis| |coveralls| |license|
Push notifications for APNS (iOS) and GCM (Android).
Install using pip:
::
pip install pushjack
Whether using APNS or GCM, pushjack provides clients for each.
Send notifications using the APNSClient class:
.. code-block:: python
from pushjack import APNSClient
client = APNSClient(certificate='<path/to/certificate.pem>',
default_error_timeout=10,
default_expiration_offset=2592000,
default_batch_size=100,
default_retries=5)
token = '<device token>'
alert = 'Hello world.'
# Send to single device.
# NOTE: Keyword arguments are optional.
res = client.send(token,
alert,
badge='badge count',
sound='sound to play',
category='category',
content_available=True,
title='Title',
title_loc_key='t_loc_key',
title_loc_args='t_loc_args',
action_loc_key='a_loc_key',
loc_key='loc_key',
launch_image='path/to/image.jpg',
extra={'custom': 'data'})
# Send to multiple devices by passing a list of tokens.
client.send([token], alert, **options)
Access response data.
.. code-block:: python
# List of all tokens sent.
res.tokens
# List of errors as APNSServerError objects
res.errors
# Dict mapping errors as token => APNSServerError object.
res.token_errors
Override defaults for error_timeout, expiration_offset, and batch_size.
.. code-block:: python
client.send(token,
alert,
expiration=int(time.time() + 604800),
error_timeout=5,
batch_size=200)
Send a low priority message.
.. code-block:: python
# The default is low_priority == False
client.send(token, alert, low_priority=True)
Get expired tokens.
.. code-block:: python
expired_tokens = client.get_expired_tokens()
Close APNS connection.
.. code-block:: python
client.close()
For the APNS sandbox, use APNSSandboxClient instead:
.. code-block:: python
from pushjack import APNSSandboxClient
Send notifications using the GCMClient class:
.. code-block:: python
from pushjack import GCMClient
client = GCMClient(api_key='<api-key>')
registration_id = '<registration id>'
alert = 'Hello world.'
notification = {'title': 'Title', 'body': 'Body', 'icon': 'icon'}
# Send to single device.
# NOTE: Keyword arguments are optional.
res = client.send(registration_id,
alert,
notification=notification,
collapse_key='collapse_key',
delay_while_idle=True,
time_to_live=604800)
# Send to multiple devices by passing a list of ids.
client.send([registration_id], alert, **options)
Alert can also be be a dictionary with data fields.
.. code-block:: python
alert = {'message': 'Hello world', 'custom_field': 'Custom Data'}
Alert can also contain the notification payload.
.. code-block:: python
alert = {'message': 'Hello world', 'notification': notification}
Send a low priority message.
.. code-block:: python
# The default is low_priority == False
client.send(registration_id, alert, low_priority=True)
Access response data.
.. code-block:: python
# List of requests.Response objects from GCM Server.
res.responses
# List of messages sent.
res.messages
# List of registration ids sent.
res.registration_ids
# List of server response data from GCM.
res.data
# List of successful registration ids.
res.successes
# List of failed registration ids.
res.failures
# List of exceptions.
res.errors
# List of canonical ids (registration ids that have changed).
res.canonical_ids
For more details, please see the full documentation at https://pushjack.readthedocs.io.
.. |version| image:: http://img.shields.io/pypi/v/pushjack.svg?style=flat-square :target: https://pypi.python.org/pypi/pushjack/
.. |travis| image:: http://img.shields.io/travis/dgilland/pushjack/master.svg?style=flat-square :target: https://travis-ci.org/dgilland/pushjack
.. |coveralls| image:: http://img.shields.io/coveralls/dgilland/pushjack/master.svg?style=flat-square :target: https://coveralls.io/r/dgilland/pushjack
.. |license| image:: http://img.shields.io/pypi/l/pushjack.svg?style=flat-square :target: https://pypi.python.org/pypi/pushjack/
.. _changelog:
ssl.PROTOCOL_TLS when creating APNS socket connection. Thanks Tanner Stirrat_!Lukas Anzinger_!apns: Add exceptions APNSProtocolError and APNSTimeoutError. Thanks Jakub Kleň_!
apns: Add retry mechanism to APNSClient.send. Thanks Jakub Kleň_!
default_retries argument to APNSClient initialization. Defaults to 5.retries argument to APNSClient.send. By default will use APNSClient.default_retries unless explicitly passed in.retries, an APNSTimeoutError will be raised.apns: Fix bug in bulk APNSClient.send that resulted in an off-by-one error for message identifier in returned errors. Thanks Jakub Kleň_!
apns: Add max payload truncation option to APNSClient.send. Thanks Jakub Kleň_!
default_max_payload_length argument to APNSClient initialization. Defaults to 0 which disabled max payload length check.max_payload_length argument to APNSClient.send. By default will use APNSClient.default_max_payload_length unless explicitly passed in.max_payload_length set, messages will be truncated to fit within the length restriction by trimming the "message" text and appending it with "...".mutable-content field (Apple Notification Service Extension) via mutable_content argument to APNSClient.send(). Thanks Ahmed Khedr_!thread-id field (group identifier in Notification Center) via thread_id argument to APNSClient.send(). Thanks Ahmed Khedr_!{"aps": {}} to be sent. Thanks Julius Seporaitis_!priority field to GCM messages via low_priority keyword argument. Default behavior is for all messages to be "high" priority. This is the opposite of GCM messages but mirrors the behavior in the APNS module where the default priority is "high".notification field to GCM messages.registration_ids field with to field when sending to a single recipient since registration_ids field has been deprecated for single recipients.Brad Montgomery_!apns: Add APNSSandboxClient for sending notifications to APNS sandbox server.
apns: Add message attribute to APNSResponse.
pushjack: Add internal logging.
apns: Fix APNS error checking to properly handle reading when no data returned.
apns: Make APNS sending stop during iteration if a fatal error is received from APNS server (e.g. invalid topic, invalid payload size, etc).
apns/gcm: Make APNS and GCM clients maintain an active connection to server.
apns: Make APNS always return APNSResponse object instead of only raising APNSSendError when errors encountered. (breaking change)
apns/gcm: Remove APNS/GCM module send functions and only support client interfaces. (breaking change)
apns: Remove config argument from APNSClient and use individual method parameters as mapped below instead: (breaking change)
APNS_ERROR_TIMEOUT => default_error_timeoutAPNS_DEFAULT_EXPIRATION_OFFSET => default_expiration_offsetAPNS_DEFAULT_BATCH_SIZE => default_batch_sizegcm: Remove config argument from GCMClient and use individual method parameters as mapped below instead: (breaking change)
GCM_API_KEY => api_keypushjack: Remove pushjack.clients module. (breaking change)
pushjack: Remove pushjack.config module. (breaking change)
gcm: Rename GCMResponse.payloads to GCMResponse.messages. (breaking change)
APNS_DEFAULT_BATCH_SIZE and set to 100.batch_size parameter to APNS send that can be used to override APNS_DEFAULT_BATCH_SIZE.send batch multiple notifications into a single payload. Previously, individual socket writes were performed for each token. Now, socket writes are batched based on either the APNS_DEFAULT_BATCH_SIZE configuration value or the batch_size function argument value.send resume sending from after the failed token when an error response is received.send raise an APNSSendError when one or more error responses received. APNSSendError contains an aggregation of errors, all tokens attempted, failed tokens, and successful tokens. (breaking change)priority argument to APNS send with low_priority=False. (breaking change)send_bulk function. Modify send to support bulk notifications. (breaking change)APNS_MAX_NOTIFICATION_SIZE as config option.GCM_MAX_RECIPIENTS as config option.request argument from GCM send function. (breaking change)sock argument from APNS send function. (breaking change)gcm: Add restricted_package_name and dry_run fields to GCM sending.
gcm: Add exceptions for all GCM server error responses.
apns: Make apns.get_expired_tokens and APNSClient.get_expired_tokens accept an optional sock argument to provide a custom socket connection.
apns: Raise APNSAuthError instead of APNSError if certificate file cannot be read.
apns: Raise APNSInvalidPayloadSizeError instead of APNSDataOverflow. (breaking change)
apns: Raise APNSInvalidTokenError instead of APNSError.
gcm: Raise GCMAuthError if GCM_API_KEY is not set.
pushjack: Rename several function parameters: (breaking change)
alert to datatoken/tokens to registration_id/registration_idsDispatcher/dispatcher to GCMRequest/requestregistration_id to device_idgcm: Return GCMResponse object for GCMClient.send/send_bulk. (breaking change)
gcm: Return requests.Response object(s) for gcm.send/send_bulk. (breaking change)
title-loc, title-loc-args, and launch-image. Previously, '_' was used in place of '-'.apns.receive_feedback.config in clients when config is a class object and subclass of Config.apns.send/send_bulk accept additional alert fields: title, title-loc, title-loc-args, and launch-image.gcm.send/send_bulk raise a GCMError exception if GCM_API_KEY is not set.data to dict if isn't not passed in as one. Original value of data is then set to {'message': data}. (breaking change)pushjack.settings module to pushjack.config. (breaking change)create_gcm_config, create_apns_config, and create_apns_sandbox_config.Config's update() method with custom method that functions similarly to from_object() except that it accepts a dict instead... _Brad Montgomery: https://github.com/bradmontgomery .. _Julius Seporaitis: https://github.com/seporaitis .. _Ahmed Khedr: https://github.com/aakhedr .. _Jakub Kleň: https://github.com/kukosk .. _Lukas Anzinger: https://github.com/Lukas0907 .. _Tanner Stirrat: https://github.com/tstirrat15
The MIT License (MIT)
Copyright (c) 2015 Derrick Gilland
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Push notifications for APNS (iOS) and GCM (Android)
We found that pushjack demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.