Skip to main content

A robust client library for Apple's push notification service.

Project description

This is a client library for Apple’s push notification service. It is not the first such library for Python, but, as is often the way, the existing options didn’t quite meet our needs:

  1. No dependencies (other than six).
  2. Fire and forget. APNs is a quirky binary protocol that frequently requires reconnecting to the service and re-sending notifications after an error.
  3. Robust. We don’t do quick and dirty here. Readability, tests, and documentation are not optional.

Quick start

An APNs client is by nature stateful. The default apns-worker backend uses Python threads to asynchronously process a queue of messages to send to the service. Most users will want to maintain a global ApnsManager instance to process messages. Note that if your own program is threaded, you may need to take care to create this global instance safely.

from apns_worker import ApnsManager

apns = None

def init_apns(key_path, cert_path):
    """ Call this once at program init time. """
    global apns
    apns = ApnsManager(key_path, cert_path)

def send_badge(token, badge=1):
    """ Badge the app on a single device. """
    apns.send_aps([token], badge=badge)

Project details


Release history Release notifications

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for apns-worker, version 0.1
Filename, size & hash File type Python version Upload date
apns_worker-0.1-py2.py3-none-any.whl (22.6 kB) View hashes Wheel py2.py3
apns-worker-0.1.tar.gz (26.8 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page