skip to navigation
skip to content

websocket-client 0.6.0

WebSocket client for python. hybi13 is supported.

Latest Version: 0.44.0

websocket-client module is WebSocket client for python. This provide the low level APIs for WebSocket. All APIs are the synchronous functions.

websocket-client supports only hybi-13.


  • LGPL


This module is tested on only Python 2.7.

Type “python install” or “pip install websocket-client” to install.

This module does not depend on any other module.


Low Level API example:

from websocket import create_connection
ws = create_connection("ws://")
print "Sending 'Hello, World'..."
ws.send("Hello, World")
print "Sent"
print "Reeiving..."
result =  ws.recv()
print "Received '%s'" % result

JavaScript websocket-like API example:

import websocket
import thread
import time

def on_message(ws, message):
    print message

def on_error(ws, error):
    print error

def on_close(ws):
    print "### closed ###"

def on_open(ws):
    def run(*args):
        for i in range(3):
            ws.send("Hello %d" % i)
        print "thread terminating..."
    thread.start_new_thread(run, ())

if __name__ == "__main__":
    ws = websocket.WebSocketApp("ws://",
                                on_message = on_message,
                                on_error = on_error,
                                on_close = on_close)
    ws.on_open = on_open

    ws.run_forever() is simple WebSocket test(debug) tool.

sample for

$ ws://
Press Ctrl+C to quit
> Hello, WebSocket
< Hello, WebSocket
> How are you?
< How are you?


usage:: [-h] [-v [VERBOSE]] ws_url

WebSocket Simple Dump Tool

positional arguments:
ws_url websocket url. ex. ws://
optional arguments:
-h, --help show this help message and exit
-v VERBOSE, --verbose VERBOSE
 set verbose mode. If set to 1, show opcode. If set to 2, enable to trace websocket module


$ ws://
$ ws:// -v
$ ws:// -vv


  • v0.6.0
    • Patches: UUID4, self.keep_running, mask_key (ISSUE#11)
    • add tool
  • v0.5.2
    • fix Echo App Demo Throw Error: ‘NoneType’ object has no attribute ‘opcode (ISSUE#10)
  • v0.5.1
    • delete invalid print statement.
  • v0.5.0
    • support hybi-13 protocol.
  • v0.4.1
    • fix incorrect custom header order(ISSUE#1)
File Type Py Version Uploaded on Size
websocket-client-0.6.0.tar.gz (md5) Source 2012-03-02 18KB