This module has been tested with Python 2.5 and 2.6.
You can install this module using your package management method or choice, normally easy_install or pip. For example:
pip install pusher
After registering at http://pusherapp.com, configure your app with the security credentials:
pusher.app_id = 'your-pusher-app-id'
pusher.key = 'your-pusher-key'
pusher.secret = 'your-pusher-secret'
Then create an instance:
p = pusher.Pusher()
Trigger an event. Channel and event names may only contain alphanumeric characters, '-' and '_':
p['a_channel'].trigger('an_event', {'some': 'data'})
You can also specify socket_id as a separate argument, as described in http://pusherapp.com/docs/duplicates:
p['a_channel'].trigger('an_event', {'some': 'data'}, socket_id)
Credentials can also be set in a per-instance basis:
p = pusher.Pusher(app_id='your-pusher-app-id', key='your-pusher-key', secret='your-pusher-secret')
If you need custom JSON serialization for handling dates or custom data types, configure pusher to use your own json module. Pusher expects the module to contain a dumps function. In the example, the custom JSON module is named custom_json_module:
pusher.json = custom_json_module
If you're using a custom encoder class, create a stub class with dumps method masquerading as a json module, locking the cls input argument using partial:
from functools import partial
pusher.json = type('CustomJson', (object,), dict(dumps=staticmethod(partial(json.dumps, cls=json.JSONEncoder))))
Or following the same pattern, setting a default encode method named default_encode_func:
from functools import partial
pusher.json = type('CustomJson', (object,), dict(dumps=staticmethod(partial(json.dumps, default=default_encode_func))))
If you're using Pusher as a Heroku add-on, you can just get the config informat
p = pusher.pusher_from_url()
To use the Tornado web server to trigger events, set channel_type:
pusher.channel_type = pusher.TornadoChannel
To see this functionality in action, look at examples/tornado_channel.py.
To force the module to use AppEngine's urlfetch, do the following on setup:
pusher.channel_type = pusher.GoogleAppEngineChannel
A channel that uses the GAE NDB (introduced in GAE 1.6.3) and provides async methods that return a future, trigger_async and send_request_async.
pusher.channel_type = pusher.GaeNdbChannel
The pusher directory contains the following test files:
- test.py
- acceptance_test.py
The tests can be run using nose. You will need to run them individually using nosetests <filename> e.g nosetests acceptance_test.py
The tests defined in acceptance_test.py execute against the Pusher service. For these to run you must rename the test_config.example.py file to test_config.py and update the values in it to valid Pusher application credential files.
Special thanks go to Steve Winton, who implemented a Pusher module in Python for the first time, with focus on AppEngine. This module borrows from his contribution at http://github.com/swinton/gae-pusherapp
Copyright (c) 2012 Pusher Ltd. See LICENSE for details.