Skip to main content

Karellen Gevent Websocket Library

Gitter chat

This is a Karellen fork of gevent-websocket. The goal of this fork is to maintain the project to support Python 3.3, 3.4 and 3.5+ as well as latest WS standards errata.

karellen-geventws 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):
        self.ws.send(message)

    def on_close(self, reason):
        print(reason)

WebSocketServer(
    ('', 8000),
    Resource({'/': EchoApplication})
).serve_forever()

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 src/unittest/python directory. Hopefully more documentation will be available soon.

Installation

The easiest way to install karellen-geventws is directly from PyPi using pip or setuptools by running the commands below:

$ pip install karellen-geventws

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

karellen-geventws is pretty fast, but can be accelerated further by installing wsaccel and ujson or simplejson:

$ pip install wsaccel ujson

karellen-geventws automatically detects wsaccel and uses the Cython implementation for UTF8 validation and later also frame masking and demasking.

Get in touch

The fork parent is located at gevent-websocket.

Issues can be created on GitHub.

Metadata

Release files for karellen-geventws 1.0.2

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

Source distribution (sdist)

Source distribution for karellen-geventws 1.0.2
File Size Uploaded Provenance Actions
karellen-geventws-1.0.2.tar.gz 15.3 kB Without provenance Details for karellen-geventws-1.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for karellen-geventws 1.0.2
File Interpreter ABI Platform Actions
karellen_geventws-1.0.2-py3-none-any.whl Python 3 none any Details for karellen_geventws-1.0.2-py3-none-any.whl

Total release size: 36.8 kB

Release files / karellen-geventws-1.0.2.tar.gz

Download URL karellen-geventws-1.0.2.tar.gz
Size 15.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b57891bf693a2b4ef0c156e54f0bb659780d5ca5326561b5c92db972bd81d0fd
BLAKE2b-256 checksum
How to use checksums
fe34d94d67151e9bb7761c3280f2a53639176a47c41913886a9f9f5ee50ff2a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / karellen_geventws-1.0.2-py3-none-any.whl

Download URL karellen_geventws-1.0.2-py3-none-any.whl
Size 21.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1a713749aa76b886d059be00863cc955a534b92dd4405be3e9647aea10f5c12d
BLAKE2b-256 checksum
How to use checksums
0ba0e8337fed777ddbb5d980d216f3ff128a3aa82c1290569e3910672b2166c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for karellen-geventws 1.0.2

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