Skip to content
Keita Suzuki edited this page Feb 13, 2020 · 5 revisions

pywebsocket3

What is it?

The pywebsocket3 project aims to provide a WebSocket standalone server. It is the successor of the original pywebsocket project which is now deprecated and archived.

Run this to read the general document:

$ pydoc mod_pywebsocket

pywebsocket is intended for testing or experimental purposes only. pywebsocket supports RFC 6455 and the following extension.

How can I use it?

To try mod_pywebsocket, please do:

git clone https://github.com/GoogleChromeLabs/pywebsocket3.git

and follow the instructions in the README.

To run mod_pywebsocket as a standalone server, please read comments in mod_pywebsocket/standalone.py.

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

Designs

For a design document of pywebsocket3, please look at this document.

Examples

The following is a list of third party examples.

Questions or suggestions?

File an issue to the GitHub repository for questions or suggestions.

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 yapf with PEP-8 styling 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.

Watching reviews and bugs

Watch pywebsocket3 repository on GitHub to watch reviews and bug issues.