# hugues-dtankouo/eyes architecture

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

- Interactive diagram: https://gitdiagram.com/hugues-dtankouo/eyes
- Repository: https://github.com/hugues-dtankouo/eyes

## Overview

##### Project Type Analysis
This is a Python-based application with a modular architecture, split into two main packages:
- 'eyes': The core application package
- 'models': The data modeling package with focus on relational database handling

##### Main Components

A. Core Application Layer (eyes package):
- Application Core (application.py)
- Scripts Module (run_check.py, run_lint.py, run_tests.py)

B. Data Layer (models package):
- Relational Database Module
- ORM Layer (SQLAlchemy)
- Database Configuration
- Schema Management

**[Component Layout]**
**Top Level:**

- EYES Core     |
- (Application)  |

- ↓

- Data Layer    |
- (Models)       |

- ↓

- Database     |

##### Specific Elements

a) Core Application Components (Blue):
- Main Application Module
- Script Runners
- Testing Framework

b) Data Layer Components (Green):
- Relational Models
- ORM Mappings
- Schema Definitions
- Configuration Management

c) Database Layer (Yellow):
- PostgreSQL Support
- SQLite Support

##### Important Technical Details to Highlight

- Poetry dependency management (shown by pyproject.toml files)
- Type checking support (py.typed files)
- Testing infrastructure
- Multiple database support

- Rectangles: Core modules
- Rounded rectangles: Services

- Blue: Application core
- Green: Data layer
- Yellow: External systems/databases

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core["Core Application Layer"]
        App["Main Application Module"]:::core
        Scripts["Scripts Module"]:::core
        Testing["Application Testing Framework"]:::testing
        TypeCheck1["Type Checking (eyes)"]:::config
    end

    subgraph DataLayer["Data Layer"]
        RelDB["Relational Database Module"]:::data
        ORM["ORM Layer (SQLAlchemy)"]:::data
        DBConfig["Database Configuration"]:::data
        Schema["Schema Management"]:::data
        Metadata["Database Metadata Handler"]:::data
        TypeCheck2["Type Checking (models)"]:::config
    end

    subgraph Database["Database Support"]
        Postgres["PostgreSQL Support"]:::db
        SQLite["SQLite Support"]:::db
    end

    subgraph Config["Configuration"]
        DepEyes["EYES Dependencies"]:::config
        DepModels["Models Dependencies"]:::config
        DBTest["Database Testing Framework"]:::testing
    end

    App --> RelDB
    App --> Scripts
    RelDB --> ORM
    ORM --> DBConfig
    DBConfig --> Schema
    Schema --> Metadata
    Metadata --> Postgres
    Metadata --> SQLite
    App --> Testing
    RelDB --> DBTest
    App --> TypeCheck1
    RelDB --> TypeCheck2
    App --> DepEyes
    RelDB --> DepModels

    %% Click Events
    click App "https://github.com/Hugues-DTANKOUO/eyes/blob/main/eyes/src/eyes/application.py"
    click Scripts "https://github.com/Hugues-DTANKOUO/eyes/tree/main/eyes/src/eyes/scripts/"
    click RelDB "https://github.com/Hugues-DTANKOUO/eyes/tree/main/models/src/models/relational/"
    click ORM "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/src/models/relational/orm/sqlalchemy.py"
    click DBConfig "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/src/models/relational/config.py"
    click Schema "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/src/models/relational/db_schema.py"
    click Metadata "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/src/models/relational/metadata.py"
    click Postgres "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/tests/relational/data/schema_postgresql.json"
    click SQLite "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/tests/relational/data/schema_sqlite.json"
    click Testing "https://github.com/Hugues-DTANKOUO/eyes/blob/main/eyes/tests/test_application.py"
    click DBTest "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/tests/relational/test_config.py"
    click TypeCheck1 "https://github.com/Hugues-DTANKOUO/eyes/blob/main/eyes/src/eyes/py.typed"
    click TypeCheck2 "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/src/models/py.typed"
    click DepEyes "https://github.com/Hugues-DTANKOUO/eyes/blob/main/eyes/pyproject.toml"
    click DepModels "https://github.com/Hugues-DTANKOUO/eyes/blob/main/models/pyproject.toml"

    %% Styles
    classDef core fill:#2374ab,stroke:#000,stroke-width:2px,color:#fff
    classDef data fill:#48a9a6,stroke:#000,stroke-width:2px,color:#fff
    classDef db fill:#e4cc37,stroke:#000,stroke-width:2px
    classDef config fill:#d4d4d4,stroke:#000,stroke-width:2px
    classDef testing fill:#e57a44,stroke:#000,stroke-width:2px,color:#fff
```
