Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Karellen Gevent Websocket Library

This is a Karellen fork of gevent-websocket. The goal of this fork is to maintain the project to support Python 3.5+ and 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 wsaccell 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.1.dev20161210051417

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.1.dev20161210051417
File Size Uploaded Provenance Actions
karellen-geventws-1.0.1.dev20161210051417.tar.gz 15.0 kB Without provenance Details for karellen-geventws-1.0.1.dev20161210051417.tar.gz

Built distribution (wheel)

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

Total release size: 36.7 kB

Release files / karellen-geventws-1.0.1.dev20161210051417.tar.gz

Download URL karellen-geventws-1.0.1.dev20161210051417.tar.gz
Size 15.0 kB
Tags Source
SHA-256 checksum
How to use checksums
7038ede4508dd6005b49f77f4c3fbedaf20607af5ca35163682075629c05ebc9
BLAKE2b-256 checksum
How to use checksums
97a1b4d1f251e926ffbe097d64dd0459b3084711a2b61d8f0e7e39f3260868ab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / karellen_geventws-1.0.1.dev20161210051417-py3-none-any.whl

Download URL karellen_geventws-1.0.1.dev20161210051417-py3-none-any.whl
Size 21.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dfce2231d287452484ed4565ef6270e3e50f846a71c7bfd00c6d9c21db4a2df2
BLAKE2b-256 checksum
How to use checksums
fc303a6d0d37ff4d55a679e9368a72af6d9781482cba8a9afcd8e3d89ce0334a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for karellen-geventws 1.0.1.dev20161210051417

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