ws4py - A WebSocket package for Python
======================================

:Author: `Sylvain Hellegouarch <http://www.defuze.org>`_
:Release: |version|
:License: `BSD <https://github.com/Lawouach/WebSocket-for-Python/blob/master/LICENSE>`_
: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 <http://tools.ietf.org/html/rfc6455>`_.

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

Overview
========

.. toctree::
   :maxdepth: 1

   sources/requirements
   sources/install
   sources/conformance
   sources/browser
   sources/performance
   sources/credits


Tutorial
========

.. toctree::
   :maxdepth: 2

   sources/basics
   sources/clienttutorial
   sources/servertutorial
   sources/managertutorial
   sources/examples

Maintainer Guide
================

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

.. toctree::
   :maxdepth: 1

   sources/maintainer/rules
   sources/maintainer/design
   sources/maintainer/testing
   sources/maintainer/documenting
   sources/maintainer/releasing

Packages
========

.. toctree::
   :maxdepth: 6

   sources/ws4py

Indices and tables
==================

* :ref:`modindex`
* :ref:`search`

