Skip to content

Getting started

Modules and handlers are fully typed; your IDE will suggest methods and fields and catch type errors.

Prerequisites

  • Python 3.12+
  • (Optional) uv or pip for install

Install

pip install urich
# For running the app:
pip install "urich[dev]"
# For CLI code generation:
pip install "urich[cli]"

Minimal app

  1. Create a file main.py:
from urich import Application
from orders.module import orders_module

app = Application()
app.register(orders_module)
app.openapi(title="My API", version="0.1.0")
  1. Run with uvicorn:
uvicorn main:app --reload

  1. Open http://localhost:8000/docs for interactive Swagger UI (no extra config). You'll see routes like:

  2. POST /orders/commands/create_order

  3. GET /orders/queries/get_order

The orders module in this example is a DomainModule: one object that declares aggregate, repository, command, query and event handler. You can scaffold it with the CLI or copy from the ecommerce example.

Using the CLI

From an empty directory:

urich create-app myapp
cd myapp
urich add-context orders --dir .
urich add-aggregate orders Order --dir .

Then in main.py (or your app entrypoint):

from urich import Application
from orders.module import orders_module

app = Application()
app.register(orders_module)
app.openapi(title="My API", version="0.1.0")

Run with uvicorn main:app --reload and visit /docs.

Next