Skip to main content

Websocket handler for the gevent pywsgi server, a Python network library

Project description


`gwebsocket`_ is a WebSocket library for the gevent_ networking library.


from gevent import pywsgi
from gwebsocket.handler import WebSocketHandler

def websocket_app(environ, start_response):
if environ["PATH_INFO"] == '/echo':
ws = environ["wsgi.websocket"]
message = ws.receive()

server = pywsgi.WSGIServer(("", 8000), websocket_app,


The easiest way to install gwebsocket is directly from PyPi_ using pip or
setuptools by running the commands below::

$ pip install gwebsocket

Gunicorn Worker

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.
Start Gunicorn using the following command and worker class to enable WebSocket
funtionality for the application.


gunicorn -k "gwebsocket.gunicorn.GWebSocketWorker" wsgi:websocket_app


`gwebsocket`_ is pretty fast, but can be accelerated further by
installing `wsaccel <>`_ and `ujson` or `simplejson`::

$ pip install wsaccel ujson

`gwebsocket`_ automatically detects ``wsaccell`` and uses the Cython
implementation for UTF8 validation and later also frame masking and demasking.

Get in touch

Issues can be created
at `Bitbucket <>`_.


gwebsocket is based on `Jeffrey Gelens`_' `gevent-websocket`_.
gwebsocket omits gevent-websocket's WAMP features and WebSocketApplication mini
framework, in favor of providing just a minimal library for use in other
frameworks. gwebsocket also makes it possible to do cleanup on close without
building your app as a WebSocketApplication.

.. _gwebsocket:
.. _gevent:
.. _Jeffrey Gelens:
.. _PyPi:
.. _repository:
.. _RFC6455:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gwebsocket-0.9.9.tar.gz (13.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page