### Navigation

- index
- modules |
- next |
- ws4py 0.3.2 documentation »

# ws4py - A WebSocket package for Python

Author: | Sylvain Hellegouarch
Release: | 0.3.2
License: | BSD
Source code: | https://github.com/Lawouach/WebSocket-for-Python
Build status: | https://travis-ci.org/Lawouach/WebSocket-for-Python

ws4py is a Python package implementing the WebSocket protocol as defined in RFC 6455.

It comes with various server and client implementations and runs on CPython 2/3, PyPy and Android.

# Overview

- Requirements
- Install ws4py
- Conformance
- Browser Support
- Performances
- Credits

# Tutorial

- Basics
- Client
  - Built-in
  - Tornado
  - gevent
- Server
  - CherryPy
  - gevent
  - wsgiref
- Managing a pool of WebSockets
  - Polling
  - Client example
- Built-in Examples
  - Real-time chat
  - Android sensors and HTML5

# Maintainer Guide

This section describes the steps to work on ws4py itself and its release process, as well as other conventions and best practices.

- Coding Rules
- Design
- Testing Overview
- Documentation process
- Release Process

# Packages

- ws4py Package
  - `ws4py` Package
  - `exc` Module
  - `framing` Module
  - `manager` Module
  - `messaging` Module
  - `streaming` Module
  - `utf8validator` Module
  - `websocket` Module
  - Subpackages
    - client Package
      - `client` Package
      - `geventclient` Module
      - `threadedclient` Module
      - `tornadoclient` Module
    - server Package
      - `cherrypyserver` Module
      - `geventserver` Module
      - `wsgirefserver` Module
      - `wsgitutils` Module

# Indices and tables

- Module Index
- Search Page

### Navigation

- index
- modules |
- next |
- ws4py 0.3.2 documentation »