Skip to content
This repository was archived by the owner on Jun 9, 2020. It is now read-only.

Home

Jump to bottom
Hiroshige Hayashizaki edited this page Aug 20, 2015 · 6 revisions

pywebsocket

What is it?

The pywebsocket project aims to provide a WebSocket standalone server and a WebSocket extension for Apache HTTP Server, mod_pywebsocket.

pywebsocket is intended for testing or experimental purposes. To run with Apache HTTP Server, mod_python is required. For wss, mod_ssl is also required.

pywebsocket supports RFC 6455 (and some legacy protocols) and the following extension.

How can I use it?

To try mod_pywebsocket, please do:

svn checkout http://pywebsocket.googlecode.com/svn/trunk/ pywebsocket-read-only

and follow the instructions in pywebsocket-read-only/src/README.

To run mod_pywebsocket as an Apache HTTP Server extension module, please read comments in pywebsocket-read-only/mod_pywebsocket/__init__.py.

To run mod_pywebsocket as a standalone server (i.e., not using Apache HTTP Server), please read comments in pywebsocket-read-only/mod_pywebsocket/standalone.py.

See TestingYourWebSocketImplementation for quick tutorial for testing your WebSocket implementation using pywebsocket.

Examples

The following is a list of third party examples.

Questions or suggestions?

We have a list for users and developers. Please join http://groups.google.com/group/pywebsocket.

For developers who intend to contribute to pywebsocket

Legal

You must complete the Individual Contributor License Agreement. You can do this online, and it only takes a minute. If you are contributing on behalf of a corporation, you must fill out the Corporate Contributor License Agreement and send it to us as described on that page.

Nuts and bolts

Basically, we apply PEP-8 coding style guide http://www.python.org/dev/peps/pep-0008/ to Python code in this project and in some case we follow some rules from Google Python style guide http://google-styleguide.googlecode.com/svn/trunk/pyguide.html if they don't conflict with PEP-8.

We use the shared Rietveld site hosted by Google AppEngine http://codereview.appspot.com for reviewing code. There's a list for watching review in Google Groups http://groups.google.com/group/pywebsocket-reviews and one for watching changes on bug tracker http://groups.google.com/group/pywebsocket-bugs.

See also WebSocketProtocolSpec, a note for developer about WebSocket protocol design

Clone this wiki locally