Skip to main content

WebSocket client for python. hybi13 is supported.

Project description

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.

License

  • LGPL

Installation

This module is tested on only Python 2.7.

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

This module does not depend on any other module.

Example

Low Level API example:

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

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):
            time.sleep(1)
            ws.send("Hello %d" % i)
        time.sleep(1)
        ws.close()
        print "thread terminating..."
    thread.start_new_thread(run, ())


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

    ws.run_forever()

ChangeLog

  • v0.5.1 - delete invalid print statement.

  • v0.5.0 - support hybi-13 protocol.

  • v0.4.1 - fix incorrect custom header order(ISSUE#1)

Project details


Release history Release notifications | RSS feed

This version

0.5.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

websocket-client-0.5.1.tar.gz (17.3 kB view details)

Uploaded Source

File details

Details for the file websocket-client-0.5.1.tar.gz.

File metadata

File hashes

Hashes for websocket-client-0.5.1.tar.gz
Algorithm Hash digest
SHA256 9a71b421ad0fbeea4705bacbe7ddded2a8109cc7c70c3c0e63ec85a259b97c8d
MD5 4e7dfcd5d767c9fb87b10c65bc8e3700
BLAKE2b-256 b5d44c7aa6e7cd99f557d8adc96ecaf7516464ee6a87af07dfadc0841addf759

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page