WebSocket library for Python (ws4py)
Python JavaScript
Switch branches/tags
Pull request Compare This branch is 495 commits behind Lawouach:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


WebSocket for Python (ws4py)

library providing support for draft-10 of the WebSocket protocol defined in http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10.

Getting Started


As a standalone client, ws4py only requires Python 2.6.6 or above though it hasn't been ported to Python 3.x yet.


In order to install ws4py you can either grab the source code and run:

 $ python setup.py install

Or use a package manager like pip and run:

 $ pip install git+git://github.com/Lawouach/WebSocket-for-Python.git

Test suite

The code currently provides a few unit tests of the stream and frame processing. For functional testing, you can use the Autobahn project (http://www.tavendo.de/autobahn) which provides an extensive test suite.

You may try to run it against the CherryPy server as follow:

 $ python ws4py/server/cherrypyserver.py

Then from a different terminal:

 $ cd Autobahn/testsuite/websockets
 $ python fuzzing_client.py

This will run the complete suite. As of this writing, the CherryPy server passes all the functional tests but fails on some performance tests by being too slow.

Test reports can be found at: http://www.defuze.org/oss/ws4py/testreports/servers/


ws4py comes with a few examples:

  • The echo_cherrypy_server provides a simple Echo server. It requires CherryPy 3.2.1. Once started, you can point your browser (it has been tested with Chrome 15.0.854.0). Open a couple of tabs pointing at http://localhost:9000 and chat accross those tables.
  • The droid_sensor_cherrypy_server broadcasts sensor metrics to clients. Point your browser to http://localhost:9000 Then run the droid_sensor module from your Android device using SL4A. A screenshot of what this renders to: http://www.defuze.org/oss/ws4py/screenshots/droidsensors.png


Many thanks to the pywebsocket and Tornado projects which have provided a good base to write ws4py. Thanks also to Jeff Lindsay (progrium) for the gevent server support.

The background in the droid example is courtesy of http://killxthexscenexstock.deviantart.com/art/Vintage-Wall-Paper-Texture-70982719