Skip to main content

Karellen Gevent Websocket Library

Project description

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.

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

Built Distribution

File details

Details for the file karellen-geventws-1.0.1.dev20161210051417.tar.gz.

File metadata

File hashes

Hashes for karellen-geventws-1.0.1.dev20161210051417.tar.gz
Algorithm Hash digest
SHA256 7038ede4508dd6005b49f77f4c3fbedaf20607af5ca35163682075629c05ebc9
MD5 3e452a711f2345bd74192e4d468cad87
BLAKE2b-256 97a1b4d1f251e926ffbe097d64dd0459b3084711a2b61d8f0e7e39f3260868ab

See more details on using hashes here.

File details

Details for the file karellen_geventws-1.0.1.dev20161210051417-py3-none-any.whl.

File metadata

File hashes

Hashes for karellen_geventws-1.0.1.dev20161210051417-py3-none-any.whl
Algorithm Hash digest
SHA256 dfce2231d287452484ed4565ef6270e3e50f846a71c7bfd00c6d9c21db4a2df2
MD5 a09d385be9d8c1aa6bcff963c88a6b32
BLAKE2b-256 fc303a6d0d37ff4d55a679e9368a72af6d9781482cba8a9afcd8e3d89ce0334a

See more details on using hashes here.

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