Websocket handler for the gevent pywsgi server, a Python network library
Project description
gevent-websocket is a websocket library for the gevent networking library written written and maintained by Jeffrey Gelens It is licensed under the BSD license.
Installation
Install Python 2.5 or newer and Gevent and its dependencies. The latest release can be download from PyPi or by cloning the repository and running:
$ python setup.py install
The easiest way to install gevent-websocket is directly from PyPi using pip or setuptools by running the commands below:
$ pip install gevent-websocket
or:
$ easy_install gevent-websocket
This also installs the dependencies automatically.
Usage
Gevent Server
At the moment gevent-websocket has one handler based on the Pywsgi gevent Hook up the WebSocketHandler to the Pywsgi Server by setting the handler_class when creating the server instance.
from gevent import pywsgi
from geventwebsocket.handler import WebSocketHandler
server = pywsgi.WSGIServer(("", 8000), websocket_app,
handler_class=WebSocketHandler)
server.serve_forever()
The handler enhances your WSGI app with a Websocket environment variable when the browser requests a Websocket connection.
def websocket_app(environ, start_response):
if environ["PATH_INFO"] == '/echo':
ws = environ["wsgi.websocket"]
message = ws.receive()
ws.send(message)
Gunicorn Server
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
Backwards incompatible changes
The wait() method was renamed to receive().
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file gevent-websocket-0.3.1.tar.gz.
File metadata
- Download URL: gevent-websocket-0.3.1.tar.gz
- Upload date:
- Size: 12.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 170e18832e1b04d8611a144cd18d68134abe1b4221358bbcc8c668cc8351f03f |
|
| MD5 | 55b1c63b0c59399abad73892f89f03b2 |
|
| BLAKE2b-256 | 12a1e089c483e5ec6fc13c1e140d286e179ad67dc63598eb7b05143091303f23 |
