1
2# pywebsocket3 #
3
4The pywebsocket project aims to provide a [WebSocket](https://tools.ietf.org/html/rfc6455) standalone server.
5
6pywebsocket is intended for **testing** or **experimental** purposes.
7
8Run this to read the general document:
9```
10$ pydoc mod_pywebsocket
11```
12
13Please see [Wiki](../../wiki) for more details.
14
15# INSTALL #
16
17To install this package to the system, run this:
18```
19$ python setup.py build
20$ sudo python setup.py install
21```
22
23To install this package as a normal user, run this instead:
24
25```
26$ python setup.py build
27$ python setup.py install --user
28```
29# LAUNCH #
30
31To use pywebsocket as standalone server, run this to read the document:
32```
33$ pydoc mod_pywebsocket.standalone
34```
35# Disclaimer #
36This is not an officially supported Google product
37