Quickstart

Install

uv add quadkit-sql

quadkit (core) and quadkit-contracts are pulled in automatically. For Postgres or MySQL, add the driver extra:

uv add "quadkit-sql[postgres]"    # asyncpg
uv add "quadkit-sql[mysql]"       # aiomysql

Minimal Setup

Configure a database and boot it with DatabaseModule:

import asyncio
from quadkit import Application
from quadkit.sql import DatabaseModule


async def main():
    async with Application.boot(
        name="my-app",
        modules=[DatabaseModule.configure("sqlite+aiosqlite:///example.db")],
    ) as app:
        print("Database connected")


asyncio.run(main())

Define a Repository

from dataclasses import dataclass
from quadkit.domain import DomainModel
from quadkit.sql import GenericRepository


@dataclass
class User(DomainModel):
    id: int | None = None
    name: str = ""
    email: str = ""


repo = GenericRepository[User, int](
    provider=db_provider,  # resolved from container
    table_name="users",
    entity_class=User,
    key_field="id",
)

Next Steps

Guide — mental model, repositories, queries, migrations
How-Tos — task-oriented recipes
Configuration — every config key