tornado_apns

A Python library for interacting with the Apple Push Notification service (APNs) for tornado async programming

Sample usage

import time
from apns import APNs, Payload
from tornado import ioloop

apns = APNs(use_sandbox=True, cert_file='cert.pem', key_file='key.pem')

def success():
    print("Sent push message to APNS gateway.")
    ioloop.IOLoop.instance().stop()

def send():
    token_hex = 'b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b87' #device token
    payload = Payload(alert="Hello World!", sound="default", badge=1)
    identifier = 1 # 一个任意的值，用于识别此消息。如果发送出现问题， 错误应答里会把identifier带回来 
    expiry = time.time() + 3600 #离线消息超时时间， 如果小于0或等于0， APNS不会保存这条消息
    apns.gateway_server.send_notification(identifier, expiry, token_hex, payload, success)

def on_response(status, seq):
    print "sent push message to APNS gateway error status %s seq %s" % (status, seq) 

def on_connected():
    apns.gateway_server.receive_response(on_response) 

# Connect the apns
apns.gateway_server.connect(on_connected)

# Wait for the connection and send a notification
ioloop.IOLoop.instance().add_timeout(time.time()+5, send)

ioloop.IOLoop.instance().start()

To send multiple notifications in a single transmission, use the Frame class. Example:

frame = Frame()
frame.add_item('b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b87', payload, identifier, expiry, priority)
apns.gateway_server.send_notification_multiple(frame, success)

For more complicated alerts including custom buttons etc, use the PayloadAlert class. Example:

alert = PayloadAlert("Hello world!", action_loc_key="Click me")
payload = Payload(alert=alert, sound="default")

To send custom payload arguments, pass a dictionary to the custom kwarg of the Payload constructor.

payload = Payload(alert="Hello World!", custom={'sekrit_number':123})

Further Info

iOS Reference Library: Local and Push Notification Programming Guide

Credits

Written and maintained by Simon Whitaker at Goo Software Ltd and tornado it by kernel1983.

Also thanks to Ethan-Zhang for contributing.