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.
Here’s how a client sends and receives messages:
#!/usr/bin/env python
import asyncio
import websockets
async def hello():
uri = "ws://localhost:8765"
async with websockets.connect(uri) as websocket:
await websocket.send("Hello world!")
await websocket.recv()
asyncio.get_event_loop().run_until_complete(hello())
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)
start_server = websockets.serve(echo, "localhost", 8765)
asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()
Do you like it? Let’s dive in!
Tutorials¶
If you’re new to websockets, this is the place to start.
How-to guides¶
These guides will help you build and deploy a websockets application.
Reference¶
Find all the details you could ask for, and then some.
Discussions¶
Get a deeper understanding of how websockets is built and why.
Project¶
This is about websockets-the-project rather than websockets-the-software.
