# shoshan-anjo/novalytics-bot architecture

> Architecture diagram of the GitHub repository shoshan-anjo/novalytics-bot, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shoshan-anjo/novalytics-bot
- Repository: https://github.com/shoshan-anjo/novalytics-bot

## Overview

##### Project Type & Purpose
- Novalitics_Bot is a Python-based automation “bot” that monitors filesystem changes (via Config/selectors.json) and drives a browser to perform tasks.
- It uses an event-driven pattern: when a file event occurs, the bot reacts by executing browser automation steps.

##### File Structure
Top-level components:
├─ main.py (entry point / orchestrator)
├─ src/core (settings.py + logger.py)
├─ src/event/file_monitor.py (filesystem watcher)
├─ src/robot/browser_control.py (browser automation)
├─ src/utils (helpers.py, validators.py)
├─ Config (config.json, selectors.json)
├─ data (watched directory)
├─ logs (logging output)
└─ requirements.txt, setup.py, .env

##### Extract Architecture Insight from README
- Core modules handle configuration & logging.
- Event module implements monitoring logic.
- Robot module handles browser interactions.
- Utils provide shared functions & input validation.

##### Main Components
a. Orchestrator (main.py)
b. Core Service
– Configuration Loader (src/core/settings.py + Config/*.json)
– Logger (src/core/logger.py → logs/)
c. Event Monitor (src/event/file_monitor.py)
d. Robot Engine (src/robot/browser_control.py)
e. Utility Library (src/utils/helpers.py, validators.py)
f. Data Stores
– Input Data Folder (data/)
– Logs Store (logs/)

##### Relationships & Data Flow
1. Startup: Orchestrator reads environment (.env) and loads settings from Config/config.json.
2. Initialization:
– Logger is configured to write to logs/.
– FileMonitor is registered (Observer pattern) against data/ using selectors.json.
3. Runtime:
– FileMonitor detects create/modify events on data/*.
– On each event, FileMonitor emits an event to the Robot Engine.
– BrowserControl executes steps (using settings.selectors) to drive the browser.
– Helper & validator utilities enforce input correctness.
– All actions & errors are logged.

##### Architectural Patterns & Principles
- Observer / Event-Driven for file monitoring callbacks.
- Single Responsibility: each module (core, event, robot, utils) has a clear role.
- Layered structure: Orchestrator → Core → Event & Robot → Utils.
- Configuration-as-Code: JSON files separate from code.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Orchestrator"
        Orchestrator["Orchestrator: main.py"]:::orchestrator
    end

    subgraph "Core Module"
        ConfigLoader["Config Loader: settings.py"]:::core
        ConfigJSON1["Config File: config.json"]:::storage
        ConfigJSON2["Selectors File: selectors.json"]:::storage
        Logger["Logger: logger.py"]:::core
        LogsDS["Logs Store: logs/"]:::storage
    end

    subgraph "Event Module"
        FileMonitor["FileMonitor: file_monitor.py"]:::event
        DataDS["Input Data Store: data/"]:::storage
    end

    subgraph "Robot Module"
        BrowserControl["BrowserControl: browser_control.py"]:::robot
        Browser["External Browser"]:::external
    end

    subgraph "Utils Library"
        Helpers["Helpers: helpers.py"]:::util
        Validators["Validators: validators.py"]:::util
    end

    Orchestrator -->|"load .env & config"| ConfigLoader
    ConfigLoader -->|"read config.json"| ConfigJSON1
    ConfigLoader -->|"read selectors.json"| ConfigJSON2
    Orchestrator -->|"init logger"| Logger
    Logger -->|"write logs"| LogsDS

    Orchestrator -->|"register watcher"| FileMonitor
    DataDS -->|"file event"| FileMonitor
    FileMonitor -->|"on event trigger"| BrowserControl

    BrowserControl -->|"drive browser"| Browser
    BrowserControl -->|"use selectors"| ConfigJSON2
    BrowserControl -->|"use settings"| ConfigJSON1
    BrowserControl -->|"use utils"| Helpers
    BrowserControl -->|"use utils"| Validators
    BrowserControl -->|"log action"| Logger

    FileMonitor -->|"use utils"| Helpers
    FileMonitor -->|"use utils"| Validators
    FileMonitor -->|"log event"| Logger

    click Orchestrator "https://github.com/shoshan-anjo/novalytics-bot/blob/master/main.py"
    click ConfigLoader "https://github.com/shoshan-anjo/novalytics-bot/blob/master/src/core/settings.py"
    click ConfigJSON1 "https://github.com/shoshan-anjo/novalytics-bot/blob/master/Config/config.json"
    click ConfigJSON2 "https://github.com/shoshan-anjo/novalytics-bot/blob/master/Config/selectors.json"
    click Logger "https://github.com/shoshan-anjo/novalytics-bot/tree/master/logs/"
    click FileMonitor "https://github.com/shoshan-anjo/novalytics-bot/blob/master/src/event/file_monitor.py"
    click BrowserControl "https://github.com/shoshan-anjo/novalytics-bot/blob/master/src/robot/browser_control.py"
    click Helpers "https://github.com/shoshan-anjo/novalytics-bot/blob/master/src/utils/helpers.py"
    click Validators "https://github.com/shoshan-anjo/novalytics-bot/blob/master/src/utils/validators.py"
    click DataDS "https://github.com/shoshan-anjo/novalytics-bot/tree/master/data/"

    classDef orchestrator fill:#0366d6,stroke:#000,color:#fff;
    classDef core fill:#28a745,stroke:#000,color:#fff;
    classDef event fill:#ffdf00,stroke:#000,color:#000;
    classDef robot fill:#d73a49,stroke:#000,color:#fff;
    classDef util fill:#17a2b8,stroke:#000,color:#fff;
    classDef storage fill:#6f42c1,stroke:#000,color:#fff;
    classDef external fill:#e36209,stroke:#000,color:#fff;
```
