pyramid_sockjs

pyramid_sockjs is a gevent <http://www.gevent.org/>-based SockJS <http://sockjs.org> integration for Pyramid <http://www.pylonsproject.org/>. SockJS interface is implemented as a pyramid route <http://pyramid.readthedocs.org/en/latest/narr/urldispatch.html>. pyramid_sockjs runs inside a WSGI application rather than WSGI server. This means all of your previous WSGI/Pyramid experience will be relevant. Its possible to create any number of different sockjs routes, ie /__sockjs__/* or /mycustom-sockjs/*. You can provide different session implementation and management for each sockjs route.

Gevent based server is required for pyramid_sockjs. For example gunicorn with gevent worker. pyramid_sockjs provides simple gevent based paster server runner::

[server:main] use = egg:pyramid_sockjs#server host = 0.0.0.0 port = 8080

Example of sockjs route::

def main(global_settings, **settings): config = Configurator(settings=settings) config.add_sockjs_route(prefix='/sockjs')

   return config.make_wsgi_app()

Client side code::

.. image :: https://secure.travis-ci.org/fafhrd91/pyramid_sockjs.png :target: https://secure.travis-ci.org/fafhrd91/pyramid_sockjs

Installation

1. Install virtualenv::

   $ wget https://raw.github.com/pypa/virtualenv/master/virtualenv.py $ python2.7 ./virtualenv.py --no-site-packages sockjs

2. Install gevent 1.0rc2 (non-Windows)::

   $ ./sockjs/bin/pip install https://github.com/surfly/gevent/archive/1.0rc2.tar.gz

3. Install gevent 1.0rc2 (Windows, 32bit Python 2.7)::

   $ ./sockjs/Scripts/easy_install https://github.com/downloads/SiteSupport/gevent/gevent-1.0rc2.win32-py2.7.exe

4. Clone pyramid_sockjs from github and then install::

   $ git clone https://github.com/fafhrd91/pyramid_sockjs.git $ cd pyramid_sockjs $ ../sockjs/bin/python setup.py develop

To run chat example use following command::

$ ./sockjs/bin/python ./pyramid_sockjs/examples/chat.py

Supported transports

• websocket (hixie-76 <http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76>_ and hybi-10 <http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10>_)
• xhr-streaming <https://secure.wikimedia.org/wikipedia/en/wiki/XMLHttpRequest#Cross-domain_requests>_
• xhr-polling <https://secure.wikimedia.org/wikipedia/en/wiki/XMLHttpRequest#Cross-domain_requests>_
• iframe-xhr-polling <https://developer.mozilla.org/en/DOM/window.postMessage>_
• iframe-eventsource (EventSource <http://dev.w3.org/html5/eventsource/>_ used from an iframe via postMessage <https://developer.mozilla.org/en/DOM/window.postMessage>_)
• iframe-htmlfile (HtmlFile <http://cometdaily.com/2007/11/18/ie-activexhtmlfile-transport-part-ii/>_ used from an iframe via postMessage <https://developer.mozilla.org/en/DOM/window.postMessage>_.)
• jsonp-polling <https://secure.wikimedia.org/wikipedia/en/wiki/JSONP>_

Limitations

• Pyramid sockjs does not support multple websocket session with same session id.

• gevent does not support Python 3

• Pyramid sockjs can't detect client disconnection on heroku.

Requirements

• Python 2.6/2.7

• virtualenv <http://pypi.python.org/pypi/virtualenv>_

• gevent 1.0rc2 or greater <http://www.gevent.org/>_

• gevent-websocket 0.3.6 or greater <http://pypi.python.org/pypi/gevent-websocket/>_

• gunicorn 0.14.3 or greater <http://gunicorn.org/>_

Examples

You can find several examples in the pyramid_sockjs repository at github.

https://github.com/fafhrd91/pyramid_sockjs/tree/master/examples

License

pyramid_sockjs is offered under the MIT license.