pyramid_sockjs is a gevent-based SockJS integration for Pyramid. SockJS interface is implemented as a pyramid route. 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:
<script src="https://cdn.sockjs.org/sockjs-0.3.min.js"></script> <script> var sock = new SockJS('https://localhost:8080/__sockjs__'); sock.onopen = function() { console.log('open'); }; sock.onmessage = function(obj) { console.log(obj); }; sock.onclose = function() { console.log('close'); }; </script>
Install virtualenv:
$ wget https://raw.github.com/pypa/virtualenv/master/virtualenv.py $ python2.7 ./virtualenv.py --no-site-packages sockjs
Install gevent 1.0b2 (non-Windows):
$ ./sockjs/bin/pip install https://gevent.googlecode.com/files/gevent-1.0b2.tar.gz
Install gevent 1.0b2 (Windows, 32bit Python 2.7):
$ ./sockjs/Scripts/easy_install https://gevent.googlecode.com/files/gevent-1.0b2-py2.7-win32.egg
Clone pyramid_sockjs from github and then install:
$ git clone git: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
- websocket (hixie-76 and hybi-10)
- xhr-streaming
- xhr-polling
- iframe-xhr-polling
- iframe-eventsource (EventSource used from an iframe via postMessage)
- iframe-htmlfile (HtmlFile used from an iframe via postMessage.)
- jsonp-polling
Pyramid sockjs does not support multple websocket session with same session id.
gevent does not support Python 3
- Python 2.6/2.7
- virtualenv
- gevent 1.0b1 or greater
- gevent-websocket 0.3.0 or greater
You can find several examples in the pyramid_sockjs repository at github.
https://github.com/fafhrd91/pyramid_sockjs/tree/master/examples
pyramid_sockjs is offered under the MIT license.