Skip to main content

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

Project description

websockets

licence version pyversions wheel tests docs

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, it provides an elegant coroutine-based API.

Documentation is available on Read the Docs.

Here’s how a client sends and receives messages:

#!/usr/bin/env python

import asyncio
from websockets import connect

async def hello(uri):
    async with connect(uri) as websocket:
        await websocket.send("Hello world!")
        await websocket.recv()

asyncio.run(hello("ws://localhost:8765"))

And here’s an echo server:

#!/usr/bin/env python

import asyncio
from websockets 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

asyncio.run(main())

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 a HTTP health check.

    If you want do to 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.

Files for websockets, version 10.1
Filename, size File type Python version Upload date Hashes
Filename, size websockets-10.1.tar.gz (83.1 kB) File type Source Python version None Upload date Hashes View
Filename, size websockets-10.1-pp37-pypy37_pp73-win_amd64.whl (97.5 kB) File type Wheel Python version pp37 Upload date Hashes View
Filename, size websockets-10.1-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (98.0 kB) File type Wheel Python version pp37 Upload date Hashes View
Filename, size websockets-10.1-pp37-pypy37_pp73-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (97.6 kB) File type Wheel Python version pp37 Upload date Hashes View
Filename, size websockets-10.1-pp37-pypy37_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl (97.7 kB) File type Wheel Python version pp37 Upload date Hashes View
Filename, size websockets-10.1-pp37-pypy37_pp73-macosx_10_9_x86_64.whl (96.0 kB) File type Wheel Python version pp37 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-win_amd64.whl (97.6 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-win32.whl (96.9 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-musllinux_1_1_x86_64.whl (109.7 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-musllinux_1_1_i686.whl (109.1 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-musllinux_1_1_aarch64.whl (109.8 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (105.8 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (110.5 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl (109.6 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-macosx_11_0_arm64.whl (96.2 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-macosx_10_9_x86_64.whl (96.2 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp310-cp310-macosx_10_9_universal2.whl (98.9 kB) File type Wheel Python version cp310 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-win_amd64.whl (97.5 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-win32.whl (96.9 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-musllinux_1_1_x86_64.whl (109.4 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-musllinux_1_1_i686.whl (108.8 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-musllinux_1_1_aarch64.whl (109.5 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (105.6 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (110.2 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl (109.3 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-macosx_11_0_arm64.whl (96.2 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-macosx_10_9_x86_64.whl (96.2 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp39-cp39-macosx_10_9_universal2.whl (98.8 kB) File type Wheel Python version cp39 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-win_amd64.whl (97.5 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-win32.whl (96.9 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-musllinux_1_1_x86_64.whl (109.5 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-musllinux_1_1_i686.whl (108.9 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-musllinux_1_1_aarch64.whl (109.7 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (106.0 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (110.3 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl (109.4 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-macosx_11_0_arm64.whl (96.2 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-macosx_10_9_x86_64.whl (96.2 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp38-cp38-macosx_10_9_universal2.whl (98.8 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-win_amd64.whl (97.5 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-win32.whl (96.8 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-musllinux_1_1_x86_64.whl (110.3 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-musllinux_1_1_i686.whl (109.7 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-musllinux_1_1_aarch64.whl (110.5 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (105.7 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (111.1 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_12_i686.manylinux2010_i686.whl (110.3 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size websockets-10.1-cp37-cp37m-macosx_10_9_x86_64.whl (96.1 kB) File type Wheel Python version cp37 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page