API Reference
The technical reference for all modules and classes within the codex-bot library. Information here is automatically generated from the source code's docstrings.
🏛 Core API (Essential)
The foundational modules required for any project built with codex-bot.
| Component | Description |
|---|---|
| base | Abstract Orchestrator and core DTOs (UnifiedViewDTO). |
| director | Transition coordinator and Smart Resolver mechanism. |
| sender | ViewSender service for SPA-like UI synchronization. |
| fsm | Isolated state management and BaseStateManager. |
🧩 Extensions (Optional)
Pluggable "batteries" to enhance your bot with additional features.
| Plugin | Description |
|---|---|
| redis | Event-driven processing via Redis Streams. |
| animation | Waiting animations for Telegram interactive UI. |
| helper | Development utilities: ID Inspector and Context Helper. |
| url_signer | HMAC security for Telegram Mini Apps. |
⚙️ Engine (Infrastructure)
The internal machinery responsible for bootstrapping and lifecycle.
| System | Description |
|---|---|
| factory | BotBuilder — fluent interface for bot assembly. |
| discovery | Automated feature scanning and registration. |
| middlewares | Standard processing layers (Throttling, Validation). |
| router_builder | Automated assembly of the main application router. |
| http | BaseApiClient for REST interactions. |
| i18n | Localization engine and locales compilation. |
🏗 Architecture
For conceptual understanding, please refer to the Architecture Overview.