Source

gevent-websocket / README.rst

Full commit

gevent-websocket

gevent-websocket is a websocket library for the Gevent networking library written written and maintained by Jeffrey Gelens It is licensed under the BSD license.

Installation

Install Python 2.4 or newer and gevent and its dependencies. The latest release can be download from PyPi or by cloning the repository.

Usage

Native Gevent

At the moment gevent-websocket has one handler based on the Pywsgi gevent server. Set the handler_class when creating a pywsgi server instance to make use of the Websocket functionality:

from gevent import pywsgi
from geventwebsocket.handler import WebSocketHandler

server = pywsgi.WSGIServer(('127.0.0.1', 8000), websocket_app,
    handler_class=WebSocketHandler)
server.serve_forever()

Afterwards write a WSGI application with a 3rd parameter, namely a websocket instance:

def websocket_app(environ, start_response, ws):
    if ws.path == '/echo':
        message = ws.wait()
        ws.send(message)

Gunicorn

Using Gunicorn it is even more easy to start a server. Only the websocket_app from the previous example is required to start the server. Dtart Gunicorn using the following command and worker class:

gunicorn -k "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" gunicorn_websocket:websocket_app