How joerdonfryeman/coinmonitor works
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