# mini-bomba/instalingpy architecture

> Architecture diagram of the GitHub repository mini-bomba/instalingpy, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mini-bomba/instalingpy
- Repository: https://github.com/mini-bomba/instalingpy

## Overview

Key Components to Include:

##### Core Components
- API Interface Layer (libs/instaling.py)
- Database Layer (libs/database.py)
- Operation Modes:
- Interactive Mode (interactive.py)
- Automatic Mode (automatic.py)
- Scheduled Mode (scheduled.py)
- Remote Control System (libs/rcon.py)
- Webhook System (libs/webhooks.py)

##### External Services
- Instaling.pl API
- MariaDB/MySQL Database
- Discord (for notifications)
- Grafana (for monitoring)

##### Component Relationships
a. User Interaction Layer:
- Three entry points (interactive.py, automatic.py, scheduled.py)
- Them to the core library components

b. Core Library Layer:
- Center the API interface (instaling.py)
- Connections to supporting modules (utils.py, classes.py, exceptions.py)
- Database interactions through database.py

c. External Services Layer:
- Connections to MariaDB
- Discord webhook integration
- Grafana monitoring connection

##### Special Features to Highlight
- Word Learning System
- Random Mistake Generator
- Delay Simulation System
- Task Scheduling System
- Remote Control Protocol

**[User Interface Layer]**
**Interactive CLI | Automatic Solver | Scheduled Daemon**
- ↓               ↓               ↓
**[Core Library Layer]**
- ┌─────────── InstalingPy Core ───────────┐
- API Interface  ←→  Word Learning     │
- Error Handling ←→  Delay Simulation  │
- Remote Control ←→  Task Scheduling   │
- ┘
- ↓               ↓           ↓
**[External Services Layer]**
**Instaling.pl API    MariaDB    Discord    Grafana**

Important Details to Include:

##### Database Schema Indicators
- Main tables for word storage
- Views for statistics
- Connections for user profiles

##### Monitoring Flow
- Data collection points
- Metrics being tracked
- Grafana dashboard connection

##### Configuration Management
- Config file interaction
- Hot-reload capability
- Profile management system

Remember to:
- Use clear, consistent symbols
- Notes about asynchronous operations
- Security boundaries
- Error handling paths
- Configuration file dependencies

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph User_Interface
        IM[Interactive Mode]
        AM[Automatic Mode]
        SM[Scheduled Mode]
    end

    subgraph Core_Library
        API[API Interface]
        DB[Database Layer]
        RC[Remote Control]
        WH[Webhook System]
        UT[Utilities]
        CL[Core Classes]
        EH[Error Handling]
        URL[URL Management]
    end

    subgraph Learning_System
        WL[Word Learning]
        RMG[Random Mistake Generator]
        DS[Delay Simulation]
    end

    subgraph External_Services
        IAPI[Instaling.pl API]
        MDB[(MariaDB)]
        DC[Discord]
        GF[Grafana]
    end

    %% User Interface connections
    IM --> API
    AM --> API
    SM --> API

    %% Core Library interconnections
    API --> WL
    API --> RMG
    API --> DS
    API --> DB
    API --> RC
    API --> WH
    API --> UT
    API --> CL
    API --> EH
    API --> URL

    %% External Service connections
    API --> IAPI
    DB --> MDB
    WH --> DC
    DB --> GF

    %% Styling
    classDef interface fill:#f9f,stroke:#333
    classDef core fill:#9cf,stroke:#333
    classDef external fill:#9f9,stroke:#333
    classDef database fill:#ff9,stroke:#333
    classDef learning fill:#fc9,stroke:#333

    class IM,AM,SM interface
    class API,DB,RC,WH,UT,CL,EH,URL core
    class IAPI,DC,GF external
    class MDB database
    class WL,RMG,DS learning

    %% Click events
    click IM "https://github.com/mini-bomba/InstalingPy/blob/master/interactive.py"
    click AM "https://github.com/mini-bomba/InstalingPy/blob/master/automatic.py"
    click SM "https://github.com/mini-bomba/InstalingPy/blob/master/scheduled.py"
    click API "https://github.com/mini-bomba/InstalingPy/blob/master/libs/instaling.py"
    click DB "https://github.com/mini-bomba/InstalingPy/blob/master/libs/database.py"
    click RC "https://github.com/mini-bomba/InstalingPy/blob/master/libs/rcon.py"
    click WH "https://github.com/mini-bomba/InstalingPy/blob/master/libs/webhooks.py"
    click UT "https://github.com/mini-bomba/InstalingPy/blob/master/libs/utils.py"
    click CL "https://github.com/mini-bomba/InstalingPy/blob/master/libs/classes.py"
    click EH "https://github.com/mini-bomba/InstalingPy/blob/master/libs/exceptions.py"
    click URL "https://github.com/mini-bomba/InstalingPy/blob/master/libs/urls.py"
    click MDB "https://github.com/mini-bomba/InstalingPy/tree/master/sql"
    click GF "https://github.com/mini-bomba/InstalingPy/blob/master/grafana_dashboard.json"
```
