|
30 | 30 |
|
31 | 31 | Quick project setup and configuration with automatic DI container setup. |
32 | 32 |
|
33 | | - [:octicons-arrow-right-24: Get Started](bootstrap/index.md) |
| 33 | + [:octicons-arrow-right-24: Read More](bootstrap/index.md) |
34 | 34 |
|
35 | 35 | - :material-code-tags: **Request Handlers** |
36 | 36 |
|
37 | 37 | Handle commands and queries with full type safety and async support. |
38 | 38 |
|
39 | | - [:octicons-arrow-right-24: Learn More](request_handler.md) |
| 39 | + [:octicons-arrow-right-24: Read More](request_handler.md) |
40 | 40 |
|
41 | 41 | - :material-sync: **Saga Pattern** |
42 | 42 |
|
43 | 43 | Orchestrated Saga for distributed transactions with automatic compensation. |
44 | 44 |
|
45 | | - [:octicons-arrow-right-24: Explore](saga/index.md) |
| 45 | + [:octicons-arrow-right-24: Read More](saga/index.md) |
46 | 46 |
|
47 | 47 | - :material-bell-ring: **Event Handling** |
48 | 48 |
|
49 | 49 | Process domain events with parallel processing and runtime execution. |
50 | 50 |
|
51 | | - [:octicons-arrow-right-24: Discover](event_handler/index.md) |
| 51 | + [:octicons-arrow-right-24: Read More](event_handler/index.md) |
52 | 52 |
|
53 | 53 | - :material-database-outline: **Transaction Outbox** |
54 | 54 |
|
|
60 | 60 |
|
61 | 61 | Sequential request processing with flexible handler chaining. |
62 | 62 |
|
63 | | - [:octicons-arrow-right-24: See Details](chain_of_responsibility/index.md) |
| 63 | + [:octicons-arrow-right-24: Read More](chain_of_responsibility/index.md) |
64 | 64 |
|
65 | 65 | - :material-play-circle: **Streaming** |
66 | 66 |
|
67 | 67 | Incremental processing with real-time progress updates via SSE. |
68 | 68 |
|
69 | | - [:octicons-arrow-right-24: Learn More](stream_handling/index.md) |
| 69 | + [:octicons-arrow-right-24: Read More](stream_handling/index.md) |
70 | 70 |
|
71 | 71 | - :material-puzzle: **Integrations** |
72 | 72 |
|
73 | 73 | FastAPI, FastStream, Kafka, and Protobuf integrations out of the box. |
74 | 74 |
|
75 | | - [:octicons-arrow-right-24: View Integrations](fastapi.md) |
| 75 | + [:octicons-arrow-right-24: Read More](fastapi.md) |
| 76 | + |
| 77 | +- :material-graph: **Mermaid Diagrams** |
| 78 | + |
| 79 | + Visualize architecture patterns and flows with interactive Mermaid diagrams. |
| 80 | + |
| 81 | + [:octicons-arrow-right-24: Read More](mermaid/index.md) |
76 | 82 |
|
77 | 83 | </div> |
78 | 84 |
|
|
92 | 98 |
|
93 | 99 | --- |
94 | 100 |
|
95 | | -## Quick Start |
| 101 | +## Installation |
| 102 | + |
| 103 | +Install Python CQRS using pip or uv: |
| 104 | + |
| 105 | +**Using pip:** |
96 | 106 |
|
97 | 107 | ```bash |
98 | 108 | pip install python-cqrs |
99 | 109 | ``` |
100 | 110 |
|
| 111 | +**Using uv:** |
| 112 | + |
| 113 | +```bash |
| 114 | +uv pip install python-cqrs |
| 115 | +``` |
| 116 | + |
| 117 | +!!! info "Requirements" |
| 118 | + Python 3.8+ • Pydantic v2 |
| 119 | + |
| 120 | +--- |
| 121 | + |
| 122 | +## Quick Start |
| 123 | + |
101 | 124 | ```python |
102 | 125 | import di |
103 | 126 | import cqrs |
@@ -127,47 +150,3 @@ result = await mediator.send(CreateUserCommand(email="user@example.com", name="J |
127 | 150 | ``` |
128 | 151 |
|
129 | 152 | See [Bootstrap](bootstrap/index.md) for detailed setup instructions. |
130 | | - |
131 | | ---- |
132 | | - |
133 | | -## Architecture |
134 | | - |
135 | | -**Request** → **RequestHandler** → **Event** → **EventHandler** |
136 | | - |
137 | | -Commands and queries flow through handlers, which execute business logic and emit events. Events are automatically dispatched to event handlers for side effects processing. |
138 | | - |
139 | | ---- |
140 | | - |
141 | | -## Installation |
142 | | - |
143 | | -```bash |
144 | | -pip install python-cqrs |
145 | | -``` |
146 | | - |
147 | | -!!! info "Requirements" |
148 | | - Python 3.8+ • Pydantic v2 |
149 | | - |
150 | | ---- |
151 | | - |
152 | | -## Documentation |
153 | | - |
154 | | -Explore the comprehensive documentation to learn more about each feature: |
155 | | - |
156 | | -- **[Bootstrap](bootstrap/index.md)** — Quick project setup and configuration |
157 | | -- **[Request Handlers](request_handler.md)** — Working with commands and queries |
158 | | -- **[Saga Pattern](saga/index.md)** — Distributed transactions with automatic compensation |
159 | | -- **[Event Handling](event_handler/index.md)** — Processing domain events |
160 | | -- **[Transaction Outbox](outbox/index.md)** — Reliable event delivery |
161 | | -- **[Stream Handling](stream_handling/index.md)** — Incremental processing with streaming |
162 | | -- **[Chain of Responsibility](chain_of_responsibility/index.md)** — Sequential request processing |
163 | | -- **[Integrations](fastapi.md)** — FastAPI, FastStream, Kafka, Protobuf |
164 | | - |
165 | | ---- |
166 | | - |
167 | | -## About |
168 | | - |
169 | | -This framework is developed by the **Timeweb.Cloud** development team. |
170 | | - |
171 | | -<div class="company-info"> |
172 | | - <p>Built with ❤️ by <a href="https://timeweb.cloud/" target="_blank" rel="noopener">Timeweb.Cloud</a> — your reliable cloud infrastructure partner.</p> |
173 | | -</div> |
0 commit comments