Metadata-Version: 2.4
Name: csrd-realtime
Version: 0.5.25
Summary: WebSocket connection lifecycle, room broadcast, and routing for real-time services
Project-URL: Repository, https://github.com/csrd-api/fastapi-common
Project-URL: Documentation, https://github.com/csrd-api/fastapi-common/tree/main/packages/realtime
Project-URL: Changelog, https://github.com/csrd-api/fastapi-common/blob/main/CHANGELOG.md
License: MIT
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# csrd WebSocket Library

**Status:** Stub (v0.1.0) — Name claimed, implementation in progress.

Real-time WebSocket connection lifecycle, room broadcast, and routing primitives for the csrd ecosystem.

## Overview

This package provides reusable WebSocket infrastructure for building real-time services on FastAPI. It handles connection registration, room membership, message routing, and optional policy hooks — but does **not** define domain-specific protocols.

## Design reference

- **Design doc:** `../../docs/WEBSOCKET_LIBRARY_DESIGN.md`
- **Implementation plan:** `../../docs/WEBSOCKET_LIBRARY_IMPLEMENTATION_PLAN.md`

## Planned v1 API (stub)

```python
from csrd.realtime import (
    ConnectionContext,
    ConnectionManager,
    MessageEnvelope,
    MessageRouter,
)
```

## Status

This is a reserved namespace stub. The full implementation will be available in v0.2.0+.
