Skip to main content

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

Project description

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Description: ================

`gevent-websocket`_ is a WebSocket library for the gevent_ networking library.

Features include:

- Integration on both socket level or using an abstract interface.
- RPC and PubSub framework using `WAMP`_ (WebSocket Application
Messaging Protocol).
- Easily extendible using a simple WebSocket protocol plugin API


from geventwebsocket import WebSocketServer, WebSocketApplication, Resource

class EchoApplication(WebSocketApplication):
def on_open(self):
print "Connection opened"

def on_message(self, message):

def on_close(self, reason):
print reason

('', 8000),
Resource({'/': EchoApplication})

or a low level implementation::

from gevent import pywsgi
from geventwebsocket.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,

More examples can be found in the ``examples`` directory. Hopefully more
documentation will be available soon.


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

$ pip install gevent-websocket

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 "geventwebsocket.gunicorn.workers.GeventWebSocketWorker" wsgi:websocket_app


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

$ pip install wsaccel ujson

`gevent-websocket`_ automatically detects ``wsaccell`` and uses the Cython
implementation for UTF8 validation and later also frame masking and

Get in touch

Get in touch on IRC #gevent on Freenode or on the Gevent `mailinglist
<!forum/gevent>`_. Issues can be created
on `Bitbucket <>`_.

.. _WAMP:
.. _gevent-websocket:
.. _gevent:
.. _Jeffrey Gelens:
.. _PyPi:
.. _repository:
.. _RFC6455:

Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Python Modules

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

gevent-websocket-0.10.1.tar.gz (18.4 kB view hashes)

Uploaded Source

Built Distribution

gevent_websocket-0.10.1-py3-none-any.whl (23.0 kB view hashes)

Uploaded Python 3

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