# snskarora/redo architecture

> Architecture diagram of the GitHub repository snskarora/redo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/snskarora/redo
- Repository: https://github.com/snskarora/redo

## Overview

##### Project type and purpose
- From the README (“Recreating Existing thing, because why not”) and the file tree, we see this is an open-source Python library (an ORM toolkit) rather than a full-stack app. Its goal is to provide a lightweight SQLAlchemy-style ORM layer that supports multiple backends (MySQL, Postgres, SQLite).

##### File structure
- Top-level “orm-py” directory contains:
- main.py – example or CLI entry point
- docker-compose.yaml – to spin up MySQL & Postgres for testing
- mysql.sql / postgres.sh – initialization scripts
- pyproject.toml / uv.lock – dependency config
- “src/sa_orm” is the core library:
- base/ – core abstractions: connection management (conn.py), model declaration (declare.py), common operations (ops.py)
- base_model.py – central Model base class
- log.py – logging utility
- mysql_orm/, postgres_orm/, sqlite_orm/ – backend-specific modules implementing db and ops

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Consumer/Application
    App["Application\n(main.py)"]:::consumer

    %% Core Library
    subgraph "sa_orm Core"
        conn["Connection Manager"]:::core
        declare["Declaration Engine"]:::core
        ops_core["Common Operations"]:::core
        base_model["BaseModel"]:::core
        logger["Logger Utility"]:::core
    end

    %% Adapters
    subgraph "Database Adapters"
        mysql_adapter["MySQL Adapter\n(db.py, ops.py)"]:::adapter
        pg_adapter["Postgres Adapter\n(db.py, ops.py)"]:::adapter
        sqlite_adapter["SQLite Adapter\n(main.py)"]:::adapter
    end

    %% External Databases
    subgraph "External Databases"
        mysql_db["MySQL Server\n(container)"]:::external
        pg_db["Postgres Server\n(container)"]:::external
        sqlite_db["SQLite File"]:::external
    end

    %% Dev/Test Tools & Config
    subgraph "Tooling & Config"
        docker["Docker-Compose"]:::tooling
        mysql_init["MySQL Init Script"]:::tooling
        pg_init["Postgres Init Script"]:::tooling
        pyproject["Dependency Config\n(pyproject.toml)"]:::tooling
        lockfile["Lockfile\n(uv.lock)"]:::tooling
    end

    %% Data Flows
    App -->|"uses"| base_model
    base_model -->|"declares models"| declare
    declare -->|"generates operations"| ops_core
    ops_core -->|"manages connections"| conn
    conn -->|"routes to adapter"| mysql_adapter
    conn -->|"routes to adapter"| pg_adapter
    conn -->|"routes to adapter"| sqlite_adapter

    mysql_adapter -->|"executes SQL"| mysql_db
    pg_adapter -->|"executes SQL"| pg_db
    sqlite_adapter -->|"executes SQL"| sqlite_db

    docker -->|"orchestrates container"| mysql_db
    docker -->|"orchestrates container"| pg_db
    docker -->|"runs init script"| mysql_init
    docker -->|"runs init script"| pg_init

    %% Click Events
    click App "https://github.com/snskarora/redo/blob/main/orm-py/main.py"
    click docker "https://github.com/snskarora/redo/blob/main/orm-py/docker-compose.yaml"
    click mysql_init "https://github.com/snskarora/redo/blob/main/orm-py/mysql.sql"
    click pg_init "https://github.com/snskarora/redo/blob/main/orm-py/postgres.sh"
    click conn "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/base/conn.py"
    click declare "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/base/declare.py"
    click ops_core "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/base/ops.py"
    click base_model "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/base_model.py"
    click logger "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/log.py"
    click mysql_adapter "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/mysql_orm/db.py"
    click mysql_adapter "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/mysql_orm/ops.py"
    click pg_adapter "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/postgres_orm/db.py"
    click pg_adapter "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/postgres_orm/ops.py"
    click sqlite_adapter "https://github.com/snskarora/redo/blob/main/orm-py/src/sa_orm/sqlite_orm/main.py"
    click pyproject "https://github.com/snskarora/redo/blob/main/orm-py/pyproject.toml"
    click lockfile "https://github.com/snskarora/redo/blob/main/orm-py/uv.lock"

    %% Styles
    classDef consumer fill:#AED6F1,stroke:#2E86C1,color:#1B4F72
    classDef core fill:#D6EAF8,stroke:#2874A6,color:#1B2631
    classDef adapter fill:#D5F5E3,stroke:#27AE60,color:#145A32
    classDef external fill:#FAD7A0,stroke:#D68910,color:#7E5109
    classDef tooling fill:#E5E7E9,stroke:#808B96,color:#1C2833
```
