This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

Makes it easy to run a SockJS server in Django through Tornado.

This package is basically a thin wrapper on top of sockjs-tornado which makes it dead easy to write websocket based apps on top of the sockjs Websocket emulation library.

With this wrapper you basically have access to everything else you need from your Django project such as your models and your various settings.

Because you need to run two processes (one for runserver (or wsgi) and one for socketserver) it means that the two really are separate python processes so you can’t easily do things like registering signals and trigger them in one process and have them fire in another.

Getting started

Create a class somewhere that looks something like this:

from sockjs.tornado import SockJSConnection

class MyConnection(SockJSConnection):
    def on_open(self, request):
         pass
    def on_message(self, message):
         pass
    def on_close(self):
         pass

Next, you need to put the loction of this in a setting in your settings.py something like this:

SOCKJS_CLASSES = (
    'myproject.myapp.myfile.MyConnection',
)

Next, to start the server simply run:

python manage.py socketserver [--help]

You’ll still have your regular django server too in a separate terminal:

python manage.py runserver

Now you should be able to write the juicy Javascript using sockjs-client. You can start by downloading the latest minified version from the CDN.

A simple app might look like this:

sock = new SockJS('http://localhost:9999/echo');
sock.onmessage = function(e) {
  console.log(e.data);
};
sock.onclose = function() {
  console.log('closed :(');
};
sock.onopen = function() {
  console.log('opened :>');
  letTheMadnessBegin();
};

function letTheMadnessBegin() {
  // silly, but you get the idea
  sock.send(JSON.stringify({
    name: $('#name').text(),
    message: $('input').val()
  }));
}

Getting fancy

There’s a shitload more things you can do with this of course. For example, you might want to add some form of authentication. Since the on_open handler receives a request you can use that to ask for request.get_cookie() which is left to the reader as an exercise.

There is a slightly more fancy example included in this package under example which might get you some ideas. It’s a fully working chat application that just works.

This package is built mainly on Serve Koval’s amazing work on sockjs-tornado which has lots of more examples and documentation that might help you. For example, it lists to a sample HAProxy configuration which you might need once you take your project live since you can’t keep exposing port 9999 on a production system.

Release History

Release History

0.0.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-sockjs-tornado-0.0.1.tar.gz (5.3 kB) Copy SHA256 Checksum SHA256 Source Sep 6, 2012

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting