Skip to content
Easy websockets for bottle.
Python
Latest commit 264998c Sep 20, 2015 @zeekay v0.2.9
Failed to load latest commit information.
bottle_websocket
examples Add LICENSE. Apr 14, 2014
.gitignore Add LICENSE. Apr 14, 2014
.hgignore Added setup.py and echo server example Sep 25, 2011
LICENSE Update LICENSE. Apr 14, 2014
README.md Misspelled xeross. Apr 16, 2012
requirements.txt Update requirements Apr 11, 2012
setup.py

README.md

This project adds websocket capabilities to bottle, leveraging gevent-websocket and gevent.

Install

Use pip or easy_install:

pip install bottle-websocket

Usage

Usage is pretty straight-forward, just import the server and plugin:

from bottle.ext.websocket import GeventWebSocketServer
from bottle.ext.websocket import websocket

You can use the websocket plugin to turn routes websocket handlers, the websocket is passed to the route as the first argument:

@get('/websocket', apply=[websocket])
def echo(ws):
    while True:
        msg = ws.receive()
        if msg is not None:
            ws.send(msg)
        else: break

And then use the provided server:

run(host='127.0.0.1', port=8080, server=GeventWebSocketServer)

Contributors

Something went wrong with that request. Please try again.