chanx

Getting Started

  • Introduction
  • Installation
  • Configuration
  • Django Quick Start
  • FastAPI Quick Start

User Guide

  • Prerequisites
  • Consumers & Decorators
  • Handler Mixins
  • AsyncAPI Documentation
  • Testing WebSocket Consumers
  • Framework Integration
  • Client Generator
  • Comparison with Other Solutions

Django Tutorial

  • Django Tutorial: Prerequisites
  • Part 1: Setup Chanx
  • Part 2: Chat WebSocket
  • Part 3: Assistants WebSocket
  • Part 4: System WebSocket
  • Part 5: Integration Tests

FastAPI Tutorial

  • FastAPI Tutorial: Prerequisites
  • Part 1: Simple System Echo WebSocket
  • Part 2: Room Chat with Channel Layers
  • Part 3: Background Jobs with ARQ
  • Part 4: Multi-Layer WebSocket Showcase
  • Part 5: Comprehensive WebSocket Testing

Examples

  • Django Complete Example
  • FastAPI Complete Example

API Reference

  • Core Module
  • Messages Module
  • Routing
  • AsyncAPI Module
  • Django Channels Integration
  • FastAPI & ASGI Frameworks Integration
  • Utils Module
  • Testing

Development

  • Contributing
  • Changelog
chanx
  • Search

© Copyright 2025, Huy Nguyen.

Built with Sphinx using a theme provided by Read the Docs.