Skip to main content

gevent-websocket

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.server import WebSocketServer, WebSocketApplication

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

    def on_message(self, message):
        self.ws.send(message)

    def on_close(self, reason):
        print reason

WebSocketServer(
    ('', 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()
        ws.send(message)

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

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

Installation

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

Performance

gevent-websocket is pretty fast, but can be accelerated further by installing wsaccel:

$ pip install wsaccel

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

Get in touch

Get in touch on IRC #gevent on Freenode or on the Gevent mailinglist. Issues can be created on Bitbucket.

Metadata

Release files for gevent-websocket 0.9.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gevent-websocket 0.9.1
File Size Uploaded Provenance Actions
gevent-websocket-0.9.1.tar.gz 18.8 kB Without provenance Details for gevent-websocket-0.9.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gevent-websocket 0.9.1
File Interpreter ABI Platform Actions
gevent_websocket-0.9.1-py27-none-any.whl Python 2.7 none any Details for gevent_websocket-0.9.1-py27-none-any.whl

Total release size: 39.7 kB

Release files / gevent-websocket-0.9.1.tar.gz

Download URL gevent-websocket-0.9.1.tar.gz
Size 18.8 kB
Tags Source
SHA-256 checksum
How to use checksums
273ffb93108aa83650d6da8330fc60cc046129cf735acb67441f4e944208b6f0
BLAKE2b-256 checksum
How to use checksums
14556cdb4b242b8d993b7f4ed51a5c9f0a8217698f7c39ce553686367f06ea1a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / gevent_websocket-0.9.1-py27-none-any.whl

Download URL gevent_websocket-0.9.1-py27-none-any.whl
Size 20.9 kB
Tags Python 2.7
SHA-256 checksum
How to use checksums
6ec45cd348a74244a217e0e5a55c9b95a1cef74e737fbab1970dae32962056b0
BLAKE2b-256 checksum
How to use checksums
ca5417d6635bbb0b263a96c419d12ea4e1a880b9c05749fc4b7fd3fcd9edd190
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for gevent-websocket 0.9.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page