Skip to main content

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

Project description

websockets

rtd pypi-v pypi-pyversions pypi-l pypi-wheel circleci codecov

What is websockets?

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

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

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

asyncio.get_event_loop().run_until_complete(
    hello('ws://localhost:8765'))

And here’s an echo server:

#!/usr/bin/env python

import asyncio
import websockets

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

asyncio.get_event_loop().run_until_complete(
    websockets.serve(echo, 'localhost', 8765))
asyncio.get_event_loop().run_forever()

Does that look good?

Get started with the tutorial!

Why should I use websockets?

The development of websockets is shaped by four principles:

  1. 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.
  2. 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.
  3. Quality: websockets is heavily tested. Continuous integration fails under 100% branch coverage. Also it passes the industry-standard Autobahn Testsuite.
  4. Performance: memory use is configurable. An extension written in C 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 to use Python 2: websockets builds upon asyncio which only works on Python 3. websockets requires Python ≥ 3.6.

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 8.0.2
Filename, size File type Python version Upload date Hashes
Filename, size websockets-8.0.2-cp36-cp36m-macosx_10_6_intel.whl (65.8 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp36-cp36m-manylinux1_i686.whl (71.9 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp36-cp36m-manylinux1_x86_64.whl (72.5 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp36-cp36m-win32.whl (65.0 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp36-cp36m-win_amd64.whl (65.7 kB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp37-cp37m-macosx_10_6_intel.whl (65.8 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp37-cp37m-manylinux1_i686.whl (71.9 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp37-cp37m-manylinux1_x86_64.whl (72.5 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp37-cp37m-win32.whl (65.0 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size websockets-8.0.2-cp37-cp37m-win_amd64.whl (65.7 kB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size websockets-8.0.2.tar.gz (57.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page