Skip to main content

An implementation of the WebSocket Protocol (RFC 6455 & 7692)

Project description


licence version pyversions tests docs openssf

What is websockets?

websockets is a library for building WebSocket servers and clients in Python with a focus on correctness, simplicity, robustness, and performance.

Built on top of asyncio, Python’s standard asynchronous I/O framework, the default implementation provides an elegant coroutine-based API.

An implementation on top of threading and a Sans-I/O implementation are also available.

Documentation is available on Read the Docs.

Here’s an echo server with the asyncio API:

#!/usr/bin/env python

import asyncio
from websockets.server import serve

async def echo(websocket):
    async for message in websocket:
        await websocket.send(message)

async def main():
    async with serve(echo, "localhost", 8765):
        await asyncio.Future()  # run forever

Here’s how a client sends and receives messages with the threading API:

#!/usr/bin/env python

from websockets.sync.client import connect

def hello():
    with connect("ws://localhost:8765") as websocket:
        websocket.send("Hello world!")
        message = websocket.recv()
        print(f"Received: {message}")


Does that look good?

Get started with the tutorial!

Why should I use websockets?

The development of websockets is shaped by four principles:

  1. Correctness: websockets is heavily tested for compliance with RFC 6455. Continuous integration fails under 100% branch coverage.

  2. Simplicity: all you need to understand is msg = await ws.recv() and await ws.send(msg). websockets takes care of managing connections so you can focus on your application.

  3. Robustness: websockets is built for production. For example, it was the only library to handle backpressure correctly before the issue became widely known in the Python community.

  4. Performance: memory usage is optimized and configurable. A C extension accelerates expensive operations. It’s pre-compiled for Linux, macOS and Windows and packaged in the wheel format for each system and Python version.

Documentation is a first class concern in the project. Head over to Read the Docs and see for yourself.

Why shouldn’t I use websockets?

  • If you prefer callbacks over coroutines: websockets was created to provide the best coroutine-based API to manage WebSocket connections in Python. Pick another library for a callback-based API.

  • If you’re looking for a mixed HTTP / WebSocket library: websockets aims at being an excellent implementation of RFC 6455: The WebSocket Protocol and RFC 7692: Compression Extensions for WebSocket. Its support for HTTP is minimal — just enough for an HTTP health check.

    If you want to do both in the same server, look at HTTP frameworks that build on top of websockets to support WebSocket connections, like Sanic.

What else?

Bug reports, patches and suggestions are welcome!

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

For anything else, please open an issue or send a pull request.

Participants must uphold the Contributor Covenant code of conduct.

websockets is released under the BSD license.

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

websockets-12.0.tar.gz (105.0 kB view hashes)

Uploaded source

Built Distributions

websockets-12.0-py3-none-any.whl (118.4 kB view hashes)

Uploaded py3

websockets-12.0-cp312-cp312-win_amd64.whl (125.0 kB view hashes)

Uploaded cp312

websockets-12.0-cp312-cp312-win32.whl (124.5 kB view hashes)

Uploaded cp312

websockets-12.0-cp311-cp311-win_amd64.whl (125.0 kB view hashes)

Uploaded cp311

websockets-12.0-cp311-cp311-win32.whl (124.5 kB view hashes)

Uploaded cp311

websockets-12.0-cp310-cp310-win_amd64.whl (125.0 kB view hashes)

Uploaded cp310

websockets-12.0-cp310-cp310-win32.whl (124.5 kB view hashes)

Uploaded cp310

websockets-12.0-cp39-cp39-win_amd64.whl (125.0 kB view hashes)

Uploaded cp39

websockets-12.0-cp39-cp39-win32.whl (124.4 kB view hashes)

Uploaded cp39

websockets-12.0-cp38-cp38-win_amd64.whl (125.0 kB view hashes)

Uploaded cp38

websockets-12.0-cp38-cp38-win32.whl (124.5 kB view hashes)

Uploaded cp38

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