How-to guides

Set up your development environment comfortably.

• Reload on code changes
• Enable debug logs

Configure websockets securely in production.

• Encrypt connections
  • Servers
  • Clients

These guides will help you design and build your application.

• Design a WebSocket application
  • Consumer pattern
  • Producer pattern
  • Consumer and producer
  • Registration
  • Publish–subscribe
• Integrate with Django
  • Authenticate connections
  • Stream events
  • Does it scale?

Upgrading from the legacy asyncio implementation to the new one? Read this.

• Upgrade to the new asyncio implementation
  • Deprecated APIs
  • Import paths
  • New features and improvements
  • API changes

If you’re integrating the Sans-I/O layer of websockets into a library, rather than building an application with websockets, follow this guide.

• Integrate the Sans-I/O layer
  • Opening a connection
  • From the network to the application
  • From the application to the network
  • Closing a connection
  • Fragmentation
  • Tips

The WebSocket protocol makes provisions for extending or specializing its features, which websockets supports fully.

• Write an extension
  • Extension factory
  • Extension