pyapns A universal Apple Push Notification Service (APNS) provider
Download

pyapns Ranking & Summary

pyapns Tags

XML-RPC Provider APNS provider XML-RPC access APNS

pyapns Description

A universal Apple Push Notification Service (APNS) provider pyapns is an APNS provider that you install on your server and access through XML-RPC. To install you will need Python, pyOpenSSL and Twisted. It's also recommended to install python-epoll for best performance (if epoll is not available, like on Mac OS X, you may want to use another library, like py-kqueue. If you like easy_install try:$ sudo easy_install twisted$ sudo easy_install pyOpenSSL # ... omit these two if already installed$ sudo easy_install pyapnspyapns is a service that runs persistently on your machine. To start it:$ twistd web --class=pyapns.server.APNSServer --port=7077 --reactor=epollTo get started right away, use the included client:$ python>>> from pyapns import configure, provision, notify>>> configure({'HOST': 'http://localhost:7077/'})>>> provision('myapp', open('cert.pem').read(), 'sandbox')>>> notify('myapp', 'hexlified_token_str', {'aps':{'alert': 'Hello!'}})The Multi-Application Modelpyapns supports multiple applications. Before pyapns can send notifications, you must first provision the application with an Application ID, the environment (either 'sandbox' or 'production') and the certificate file. The provision method takes 3 arguments, app_id, path_to_cert_or_cert, and environment. A connection is kept alive for each application provisioned for the fastest service possible. The application ID is an arbitrary identifier and is not used in communication with the APNS servers.Attempts to provision the same application id multiple times are ignored.Sending NotificationsCalling notify will send the message immediately if a connection is already established. The first notification may be delayed a second while the server connects. notify takes app_id, token_or_token_list and notification_or_notification_list. Multiple notifications can be batched for better performance by using paired arrays of token/notifications. When performing batched notifications, the token and notification arrays must be exactly the same length.The full notification dictionary must be included as the notification:{'aps': { 'sound': 'flynn.caf', 'badge': 0, 'message': 'Hello from pyapns :)' }} # etc...Retrieving Inactive TokensCall feedback with the app_id. A list of tuples will be retrieved from the APNS server that it deems inactive. These are returned as a list of 2-element lists with a Datetime object and the token string.XML-RPC MethodsprovisionArguments app_id String the application id for the provided certification cert String a path to a .pem file or the a string with the entie file environment String the APNS server to use - either 'production' or 'sandbox'Returns NonenotifyArguments app_id String the application id to send the message to tokens String or Array an Array of tokens or a single token string notifications String or Array an Array of notification dictionaries or a single notification dictionaryReturns NonefeedbackArguments app_id String the application id to retrieve retrieve feedback forReturns Array(Array(Datetime(time_expired), String(token)), ...)The Python APIpyapns also provides a Python API that makes the use of pyapns even simpler. The Python API must be configured before use but configuration files make it easier. The pyapns client module currently supports configuration from Django settings and Pylons config. To configure using Django, the following must be present in your settings file:PYAPNS_CONFIG = { 'HOST': 'http://localhost:8077/', 'INITIAL': }Optionally, with Django settings, you can skip manual provisioning by including a list of (name, path, environment) tuples that are guaranteed to be provisioned by the time you call notify or feedback.Configuring for pylons is just as simple, but automatic provisioning isn't possible, in your configuration file include:pyapns_host = http://localhost:8077/Each of these functions can be called synchronously and asynchronously. To make them perform asynchronously simply supply a callback. The request will then be made in another thread and callback with the results. When calling asynchronously no value will be returned:def got_feedback(tuples): trim_inactive_tokens(tuples)feedback('myapp', callback=got_feedback)pyapns.client.configure(opts)Takes a dictionary of options and configures the client.Currently configurable options are 'HOST' and 'INITIAL' the latterof which is only read once.Config Options: HOST - A full host name with port, ending with a forward slash INITIAL - A List of tuples to be supplied to provision when the first configuration happens.pyapns.client.provision(app_id, path_to_cert_or_cert, environment, callback=None)Provisions the app_id and initializes a connection to the APNS server.Multiple calls to this function will be ignored by the pyapns daemonbut are still sent so pick a good place to provision your apps, optimallyonce.Arguments: app_id the app_id to provision for APNS path_to_cert_or_cert absolute path to the APNS SSL cert or a string containing the .pem file environment either 'sandbox' or 'production' callback a callback to be executed when doneReturns: Nonepyapns.client.notify(app_id, tokens, notifications, callback=None)Sends push notifications to the APNS server. Multiplenotifications can be sent by sending pairing the token/notificationarguments in lists , .Arguments: app_id provisioned app_id to send to tokens token to send the notification or a list of tokens notifications notification dicts or a list of notifications callback a callback to be executed when done Returns: Nonepyapns.client.feedback(app_id, callback=None)Retrieves a list of inactive tokens from the APNS server and the timesit thinks they went inactive.Arguments: app_id the app_id to queryReturns: Feedback tuples like Here are some key features of "pyapns": · XML-RPC Based, works with any client in any language · Native Python API with Django and Pylons support · Scalable, fast and easy to distribute behind a proxy · Based on Twisted · Multi-application and dual environment support · Simplified feedback interface Requirements: · Python · pyOpenSSL · Twisted

pyapns Related Software