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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for aaugustin from gravatar.com aaugustin

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for aaugustin from gravatar.com aaugustin

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

14.1

14.0

13.1

13.0.1

13.0

12.0

11.0.3

11.0.2

11.0.1

11.0

10.4

10.3

10.2

10.1

10.0

9.1

9.0.2

9.0.1

9.0

8.1

This version

8.0.2

8.0.1

8.0

7.0

6.0

5.0.1

5.0

4.0.1

4.0

3.4

3.3

3.2

3.1

3.0

2.7

2.6

2.5

2.4

2.3

2.2

2.1

2.0

1.0

0.1

Download files

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

Source Distribution

websockets-8.0.2.tar.gz (57.3 kB view details)

Uploaded Source

Built Distributions

websockets-8.0.2-cp37-cp37m-win_amd64.whl (65.7 kB view details)

Uploaded CPython 3.7m Windows x86-64

websockets-8.0.2-cp37-cp37m-win32.whl (65.0 kB view details)

Uploaded CPython 3.7m Windows x86

websockets-8.0.2-cp37-cp37m-manylinux1_x86_64.whl (72.5 kB view details)

Uploaded CPython 3.7m

websockets-8.0.2-cp37-cp37m-manylinux1_i686.whl (71.9 kB view details)

Uploaded CPython 3.7m

websockets-8.0.2-cp37-cp37m-macosx_10_6_intel.whl (65.8 kB view details)

Uploaded CPython 3.7m macOS 10.6+ intel

websockets-8.0.2-cp36-cp36m-win_amd64.whl (65.7 kB view details)

Uploaded CPython 3.6m Windows x86-64

websockets-8.0.2-cp36-cp36m-win32.whl (65.0 kB view details)

Uploaded CPython 3.6m Windows x86

websockets-8.0.2-cp36-cp36m-manylinux1_x86_64.whl (72.5 kB view details)

Uploaded CPython 3.6m

websockets-8.0.2-cp36-cp36m-manylinux1_i686.whl (71.9 kB view details)

Uploaded CPython 3.6m

websockets-8.0.2-cp36-cp36m-macosx_10_6_intel.whl (65.8 kB view details)

Uploaded CPython 3.6m macOS 10.6+ intel

File details

Details for the file websockets-8.0.2.tar.gz.

File metadata

  • Download URL: websockets-8.0.2.tar.gz
  • Upload date:
  • Size: 57.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for websockets-8.0.2.tar.gz
Algorithm Hash digest
SHA256 882a7266fa867a2ebb2c0baaa0f9159cabf131cf18c1b4270d79ad42f9208dc5
MD5 a37f0e22c3aa5f1cf12a6a3ae22b36ca
BLAKE2b-256 797817e97a159dc55308b1468a638c7267f19765281f6205ec9c15253c154022

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: websockets-8.0.2-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 65.7 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for websockets-8.0.2-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 049e694abe33f8a1d99969fee7bfc0ae6761f7fd5f297c58ea933b27dd6805f2
MD5 1b1f99f468c24e4c123b2fbbc80d842c
BLAKE2b-256 9c60f96f535f3354cb6ba5e5c7ab128b1c4802a2d040ee7225e3fe51242816c1

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp37-cp37m-win32.whl.

File metadata

  • Download URL: websockets-8.0.2-cp37-cp37m-win32.whl
  • Upload date:
  • Size: 65.0 kB
  • Tags: CPython 3.7m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for websockets-8.0.2-cp37-cp37m-win32.whl
Algorithm Hash digest
SHA256 f5cb2683367e32da6a256b60929a3af9c29c212b5091cf5bace9358d03011bf5
MD5 f8792067b3866a51b7c65c62cb240214
BLAKE2b-256 71144a1e84fd8701e05b7e97cb84a833c6a3f18427b5d5cefde7c0d66b44dab8

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: websockets-8.0.2-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 72.5 kB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1

File hashes

Hashes for websockets-8.0.2-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 a7affaeffbc5d55681934c16bb6b8fc82bb75b175e7fd4dcca798c938bde8dda
MD5 c135d083379f0e40253c08d6547e3b12
BLAKE2b-256 49afd01b9d7a6c95d86c8f3c3df7a152f4e3d131fb1fe54facea103a3fd89ed4

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp37-cp37m-manylinux1_i686.whl.

File metadata

  • Download URL: websockets-8.0.2-cp37-cp37m-manylinux1_i686.whl
  • Upload date:
  • Size: 71.9 kB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1

File hashes

Hashes for websockets-8.0.2-cp37-cp37m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 8c77f7d182a6ea2a9d09c2612059f3ad859a90243e899617137ee3f6b7f2b584
MD5 0cb600d39120c94ceb0fbc17fe540fab
BLAKE2b-256 21f13bcde69c268b44026768a4c20bc617e16c8c568ff3a9aa1af04a973bb22b

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp37-cp37m-macosx_10_6_intel.whl.

File metadata

  • Download URL: websockets-8.0.2-cp37-cp37m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 65.8 kB
  • Tags: CPython 3.7m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for websockets-8.0.2-cp37-cp37m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 73ce69217e4655783ec72ce11c151053fcbd5b837cc39de7999e19605182e28a
MD5 abd9ae819e6817bfbf40f71cf358a03c
BLAKE2b-256 8b6bdcbafe10a1b889f3d31bef7048dbfb23973d4b56e8fb47c9158c47fa5643

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: websockets-8.0.2-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 65.7 kB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for websockets-8.0.2-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 c82e286555f839846ef4f0fdd6910769a577952e1e26aa8ee7a6f45f040e3c2b
MD5 025f1d61a55f2e154dc49279f2891911
BLAKE2b-256 6abd8555c65b3fca7310b2601d0957b36511c3c3c2e8a93a6d3f90c671b70c6a

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp36-cp36m-win32.whl.

File metadata

  • Download URL: websockets-8.0.2-cp36-cp36m-win32.whl
  • Upload date:
  • Size: 65.0 kB
  • Tags: CPython 3.6m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for websockets-8.0.2-cp36-cp36m-win32.whl
Algorithm Hash digest
SHA256 8d7a20a2f97f1e98c765651d9fb9437201a9ccc2c70e94b0270f1c5ef29667a3
MD5 f190f72787dfcc1b98be5842725e2b63
BLAKE2b-256 36602301775ccbdc4082a5e44743ca8aed7939ba2cc67c1ac6961f6172c1fb44

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: websockets-8.0.2-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 72.5 kB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1

File hashes

Hashes for websockets-8.0.2-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 e9102043a81cdc8b7c8032ff4bce39f6229e4ac39cb2010946c912eeb84e2cb6
MD5 6f407d9bd81e30a7109e74abec9b179b
BLAKE2b-256 f04bad228451b1c071c5c52616b7d4298ebcfcac5ae8515ede959db19e4cd56d

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp36-cp36m-manylinux1_i686.whl.

File metadata

  • Download URL: websockets-8.0.2-cp36-cp36m-manylinux1_i686.whl
  • Upload date:
  • Size: 71.9 kB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1

File hashes

Hashes for websockets-8.0.2-cp36-cp36m-manylinux1_i686.whl
Algorithm Hash digest
SHA256 83e63aa73331b9ca21af61df8f115fb5fbcba3f281bee650a4ad16a40cd1ef15
MD5 b41b3a31a77fa4e3e17bd040cd4ebc9a
BLAKE2b-256 a5e5ceb80a4952a24303f559c49ea2cb4ddbd9917c3dc6db456c3ab59f612747

See more details on using hashes here.

File details

Details for the file websockets-8.0.2-cp36-cp36m-macosx_10_6_intel.whl.

File metadata

  • Download URL: websockets-8.0.2-cp36-cp36m-macosx_10_6_intel.whl
  • Upload date:
  • Size: 65.8 kB
  • Tags: CPython 3.6m, macOS 10.6+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for websockets-8.0.2-cp36-cp36m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 e906128532a14b9d264a43eb48f9b3080d53a9bda819ab45bf56b8039dc606ac
MD5 2759f1f3055d8a2e6a0dfc12ead9e1f2
BLAKE2b-256 cd2d7d1e969854d50e2e4adfc38a7bdfab0d470444d340c4eae3ba176fa4765c

See more details on using hashes here.

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