# joerdonfryeman/coinmonitor architecture

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

- Interactive diagram: https://gitdiagram.com/joerdonfryeman/coinmonitor
- Repository: https://github.com/joerdonfryeman/coinmonitor

## Overview

##### Project type and purpose
- CoinMonitor is a stand-alone command-line (console) application written in Python.
- Its job: load user settings, fetch live crypto-price data from one or more public APIs (e.g. CoinMarketCap), and render a continuously updating view in the terminal (using curses or equivalent).

##### File structure
- Top-level scripts:
- main.py        → entry point; kicks off the application loop
- coin_monitor.py → core “engine” that orchestrates fetch-process-render
- base.py        → shared utilities, logging or common abstractions
- configuration.py → loads/parses JSON settings
- config_files/  → contains example JSON configs
- Requirements files for Linux/Windows specify dependencies: aiohttp, windows-curses, etc.

##### README for additional insights
- Confirms module responsibilities.
- Notes use of aiohttp for asynchronous HTTP, and curses (or windows-curses) for terminal UI.

##### Main components and their interactions
a. Components:
1. CLI Launcher (main.py)
2. Configuration Loader (configuration.py + config JSON)
3. Monitoring Engine (coin_monitor.py)
4. Core Utilities (base.py)
5. External API Service(s) (e.g. CoinMarketCap)
6. Terminal UI Renderer (curses / windows-curses)
b. Interactions:
- User invokes main.py → passes control to Configuration Loader
- Configuration Loader reads JSON → provides settings to Monitoring Engine
- Monitoring Engine (using Base utilities):
– Makes asynchronous HTTP calls to external API(s) via aiohttp
– Receives JSON payloads of price data
– Processes/normalizes data
- Processed data flows into Terminal UI Renderer → updates display in a loop
- Optionally logs events or errors via Base module
c. Architectural patterns & design principles:
- Separation of concerns: config, core logic, I/O, rendering all in separate modules
- Asynchronous I/O: aiohttp for non-blocking network calls
d. Key technologies:
- Python 3.13
- aiohttp (async HTTP client)
- curses / windows-curses (terminal rendering)
- JSON configuration files

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Configuration Layer
    subgraph "Configuration Layer"
        ConfigLoader["Configuration Loader\nconfiguration.py"]:::config
        ConfigFiles["Config Files\nconfig_files/"]:::config
    end

    %% Core Layer
    subgraph "Core Layer"
        CLI["CLI Launcher\nmain.py"]:::core
        Base["Core Utilities\nbase.py"]:::core
        Monitor["Monitoring Engine\ncoin_monitor.py"]:::core
    end

    %% External Dependencies
    External["External APIs\n(e.g. CoinMarketCap)"]:::external

    %% UI Layer
    subgraph "UI Layer"
        UI["Terminal UI Renderer\n(curses/windows-curses)"]:::ui
        Icons["Icons/Assets\nicons/"]:::ui
    end

    %% Flows
    CLI -->|"1. init"| ConfigLoader
    ConfigLoader -->|"load settings"| ConfigFiles
    ConfigLoader -->|"settings"| Monitor
    ConfigLoader -->|"fallback settings if missing"| Base
    Monitor -->|"uses utilities"| Base
    Monitor -->|"2. async fetch price data"| External
    External -->|"price JSON"| Monitor
    Monitor -->|"3. process & normalize"| Monitor
    Monitor -->|"4. render frame"| UI
    Icons -->|"assets"| UI
    Monitor -->|"loop until exit"| Monitor

    %% Click Events
    click CLI "https://github.com/joerdonfryeman/coinmonitor/blob/main/main.py"
    click ConfigLoader "https://github.com/joerdonfryeman/coinmonitor/blob/main/configuration.py"
    click ConfigFiles "https://github.com/joerdonfryeman/coinmonitor/tree/main/config_files/"
    click Monitor "https://github.com/joerdonfryeman/coinmonitor/blob/main/coin_monitor.py"
    click Base "https://github.com/joerdonfryeman/coinmonitor/blob/main/base.py"
    click Icons "https://github.com/joerdonfryeman/coinmonitor/tree/main/icons/"

    %% Styles
    classDef config fill:#add8e6,stroke:#333,stroke-width:1px
    classDef core fill:#90ee90,stroke:#333,stroke-width:1px
    classDef external fill:#ffcc99,stroke:#333,stroke-width:1px
    classDef ui fill:#dda0dd,stroke:#333,stroke-width:1px
```
