python-websockets/websockets
Websockets
websockets is a Python library that provides both client and server implementations for the WebSocket protocol, enabling real-time, bidirectional communication between applications. At its core, it offers the fundamental primitives for establishing persistent connections, managing their lifecycles, and exchanging text or binary messages asynchronously using coroutines.
The library distinguishes itself through comprehensive support for various messaging patterns, including broadcast messaging to all connected clients, targeted messaging to specific clients, and shared application state synchronization across multiple connections. It also includes a command-line interactive client for testing and debugging WebSocket endpoints directly from the terminal.
Beyond the core protocol implementation, websockets provides production deployment guidance across multiple platforms and environments, including Kubernetes, Fly.io, Heroku, and Koyeb, as well as configurations for reverse proxies like HAProxy and process managers like Supervisor. The documentation covers TLS setup, load balancing, and other production considerations for running WebSocket servers reliably.
Features
- WebSocket Servers - Provides a server-side implementation for starting a WebSocket listener and handling messages asynchronously using coroutines.
- Broadcast Messaging - Supports sending a message from the server to every currently connected WebSocket client simultaneously.
- Websocket Connection Managers - Handles WebSocket connection lifecycle including opening, closing, and error recovery to keep application code simple.
- Real-Time Connections - Establishes persistent bidirectional connections between servers and clients for real-time message exchange.
- Text and Binary Message Exchanges - Enables bidirectional transmission of both UTF-8 text and raw binary messages over open WebSocket connections.
- WebSocket Clients - Provides client-side functionality to initiate WebSocket connections and exchange messages bidirectionally with remote servers.
- WebSocket Message Interception - Enables sending and receiving text or binary messages through an open WebSocket connection in either direction.
- WebSocket Deployments - Provides guidance for packaging and deploying a WebSocket server with its frontend to a production web environment.
- WebSocket Reverse Proxy Deployments - Documents how to route WebSocket traffic through a reverse proxy by translating the Upgrade handshake and forwarding frames.
- Production Configurations - Provides comprehensive production deployment guidance including TLS, reverse proxies, and process management for WebSocket servers.
- Targeted WebSocket Messaging - Supports directing messages from the server to a particular connected client using a routing key or identifier.
- WebSocket Terminal Clients - Ships a command-line interactive client for testing and debugging WebSocket endpoints directly from the terminal.
- WebSocket State Synchronization - Synchronizes application state across multiple WebSocket connections to support collaborative features.
- Websockets - Listed in the “Websockets” section of the Awesome Python awesome list.
- WebSocket - A library for building WebSocket servers and clients.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
