fix: update docs for client generation

Author: huynguyengl99

README.rst

@@ -106,12 +106,6 @@ Built on years of real-world WebSocket development experience, Chanx provides pr
 Installation
 ------------
 
-**Basic Installation (Core Only)**
-
-.. code-block:: bash
-
-    pip install chanx
-
 **For Django Channels Projects**
 
 .. code-block:: bash
@@ -124,6 +118,18 @@ Installation
 
     pip install "chanx[fast_channels]"
 
+**For Client Generator CLI**
+
+.. code-block:: bash
+
+    pip install "chanx[cli]"
+
+**For Using Generated Clients**
+
+.. code-block:: bash
+
+    pip install "chanx[client]"
+
 
 Prerequisites
 -------------
@@ -381,6 +387,9 @@ Key Features
 **AsyncAPI 3.0 Generation**
   Auto-generate interactive documentation and OpenAPI-style specs from decorated handlers
 
+**Type-Safe Client Generator**
+  Generate Python WebSocket clients from AsyncAPI schemas with full type safety and IDE support
+
 **Authentication System**
   Built-in ``DjangoAuthenticator`` with DRF permission support, extensible ``BaseAuthenticator`` for custom flows
 
@@ -396,11 +405,37 @@ Key Features
 **Configuration Management**
   Django settings integration via ``CHANX`` dict, class-level config for FastAPI consumers
 
+Client Generator
+----------------
+
+Generate type-safe Python clients from your AsyncAPI schema:
+
+.. code-block:: bash
+
+    # Generate from local file (JSON or YAML)
+    chanx generate-client --schema asyncapi.json --output ./my_client
+    chanx generate-client --schema asyncapi.yaml --output ./my_client
+
+    # Generate directly from URL (no need to download)
+    chanx generate-client --schema http://localhost:8000/asyncapi.json --output ./my_client
+
+.. code-block:: python
+
+    # Use generated client with full type safety
+    from my_client.chat import ChatClient, ChatMessage, ChatPayload
+
+    client = ChatClient("localhost:8000")
+
+    await client.send_message(
+        ChatMessage(payload=ChatPayload(message="Hello!"))
+    )
+
 Learn More
 ----------
 
 * `Documentation <https://chanx.readthedocs.io/>`_ - Complete guide and API reference
 * `Django Quick Start <https://chanx.readthedocs.io/en/latest/quick-start-django.html>`_ - Django-specific setup
 * `FastAPI Quick Start <https://chanx.readthedocs.io/en/latest/quick-start-fastapi.html>`_ - FastAPI-specific setup
 * `User Guide <https://chanx.readthedocs.io/en/latest/user-guide/prerequisites.html>`_ - In-depth features and patterns
+* `Client Generator Guide <https://chanx.readthedocs.io/en/latest/user-guide/client-generator.html>`_ - Generate type-safe clients
 * `Examples <https://chanx.readthedocs.io/en/latest/examples/django.html>`_ - Real-world implementation examples

docs/index.rst

@@ -24,6 +24,7 @@ Contents
    user-guide/asyncapi
    user-guide/testing
    user-guide/framework-integration
+   user-guide/client-generator
    comparison
 
 .. toctree::

docs/installation.rst

@@ -14,11 +14,6 @@ Framework-specific dependencies are installed automatically based on which extra
 
 Installing Chanx
 ----------------
-**Basic Installation (Core Only)**
-
-.. code-block:: bash
-
-    pip install chanx
 
 **For Django Channels Projects**
 
@@ -28,10 +23,11 @@ Installing Chanx
 
 This installs:
 
+- Pydantic 2.0+ (validation)
 - Django 5.0+
 - Django Channels 4.0+
 - Django REST Framework 3.0+
-- Channels Redis 4.0+
+- Core dependencies (pyhumps, structlog, typing-extensions)
 
 **For FastAPI and Other ASGI Frameworks**
 
@@ -41,8 +37,47 @@ This installs:
 
 This installs:
 
+- Pydantic 2.0+ (validation)
 - FastAPI 0.117+
 - fast-channels 1.0+
+- Core dependencies (pyhumps, structlog, typing-extensions)
+
+**For Client Generator CLI + Generated Clients**
+
+If you need both the CLI tool (for generating clients) and the ability to use generated clients:
+
+.. code-block:: bash
+
+    # Using pip
+    pip install "chanx[cli,client]"
+
+    # Using uv (recommended approach)
+    uv add chanx[client]           # Runtime dependency
+    uv add --group dev chanx[cli]  # Development dependency
+
+This installs:
+
+- **Runtime (client)**: Pydantic 2.0+, websockets
+- **Development (cli)**: click, httpx, jinja2, pyyaml (for code generation)
+
+**For Using Generated Clients Only**
+
+If you only need to use a generated client (not generate new ones):
+
+.. code-block:: bash
+
+    # Using pip
+    pip install "chanx[client]"
+
+    # Using uv
+    uv add chanx[client]
+
+This installs only:
+
+- Pydantic 2.0+ (for message validation)
+- websockets (for WebSocket connectivity)
+
+No CLI tools, no server dependencies - just what's needed to run the generated client code.
 
 **Install from Source**
 
@@ -130,12 +165,33 @@ Chanx includes automatic camelCase conversion. Enable it in your configuration:
         camelize = True
 
 
+CLI Usage
+---------
+
+Once installed, you can use the client generator CLI with local files or URLs:
+
+.. code-block:: bash
+
+    # Generate from local file (JSON or YAML)
+    chanx generate-client --schema asyncapi.json --output ./my_client
+    chanx generate-client --schema asyncapi.yaml --output ./my_client
+
+    # Generate directly from URL (no download needed)
+    chanx generate-client --schema http://localhost:8000/asyncapi.json --output ./my_client
+    chanx generate-client --schema https://api.example.com/asyncapi.yaml --output ./my_client
+
+    # With custom formatter
+    chanx generate-client --schema asyncapi.json --output ./my_client --formatter "black"
+
+See :doc:`user-guide/client-generator` for complete CLI documentation.
+
 Next Steps
 ----------
 Now that you have Chanx installed, proceed to:
 
 * :doc:`quick-start-django` - Create your first Django WebSocket consumer
 * :doc:`quick-start-fastapi` - Create your first FastAPI WebSocket consumer
+* :doc:`user-guide/client-generator` - Generate type-safe Python clients
 * :doc:`user-guide/prerequisites` - Start with the user guide prerequisites
 * :doc:`examples/django` - See Django implementation examples
 * :doc:`examples/fastapi` - See FastAPI implementation examples

docs/introduction.rst

@@ -119,7 +119,7 @@ How Chanx Solves This
     # ✅ Pydantic validates at runtime
     # ✅ Framework auto-generates discriminated unions
 
-**3. Auto-Generated Documentation - Always Up-to-Date**
+**3. Auto-Generated Documentation & Type-Safe Clients**
 
 .. code-block:: python
 
@@ -137,6 +137,26 @@ How Chanx Solves This
    :alt: AsyncAPI Documentation automatically generated from Chanx decorators
    :align: center
 
+**Generate Type-Safe Python Clients**
+
+.. code-block:: bash
+
+    # Generate from local file or URL (JSON/YAML supported)
+    chanx generate-client --schema asyncapi.json --output ./my_client
+    chanx generate-client --schema http://localhost:8000/asyncapi.json --output ./my_client
+
+.. code-block:: python
+
+    # Use generated client with full type safety
+    from my_client.chat import ChatClient, ChatMessage, ChatPayload
+
+    client = ChatClient("localhost:8000")
+    await client.send_message(
+        ChatMessage(payload=ChatPayload(message="Hello!"))
+    )
+
+See :doc:`user-guide/client-generator` for complete client generation guide.
+
 **4. Multi-Framework Support - Works Everywhere**
 
 .. code-block:: python