-
Notifications
You must be signed in to change notification settings - Fork 148
Home
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.
To try mod_pywebsocket, please do:
git clone https://github.com/google/pywebsocket.git
and follow the instructions in README.
To run mod_pywebsocket as an Apache HTTP Server extension module, please read comments in mod_pywebsocket/__init__.py.
To run mod_pywebsocket as a standalone server (i.e., not using Apache HTTP Server), please read comments in mod_pywebsocket/standalone.py.
See TestingYourWebSocketImplementation for quick tutorial for testing your WebSocket implementation using pywebsocket.
The following is a list of third party examples.
We have a list for users and developers. Please join https://groups.google.com/group/pywebsocket.
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.
Basically, we apply PEP-8 coding style guide to Python code in this project and in some case we follow some rules from Google Python style guide if they don't conflict with PEP-8.
We use pull requests for reviewing code. Please send a pull request and get lgtm. See CodeReviewInstruction for more details.
See also WebSocketProtocolSpec, a note for developer about WebSocket protocol design.
Watch pywebsocket repository on GitHub to watch reviews and bug issues.
OBSOLETE: pywebsocket-reviews and pywebsocket-bugs are no longer used after pywebsocket is migrated to GitHub in August 2015.