How steelball-debug/expense-tracker works
Project type and purpose
• This is a desktop application (“Koin – Expense Tracker App”) written in Python, using CustomTkinter for the GUI.
• It provides personal finance tracking, multi-user support, and offline data storage (JSON).
File structure
• Entry Point: main.py
• GUI Modules (Views & Controllers):
• Scripts/Dashboard.py
• Scripts/Heatmap.py
• Scripts/Tabular_view.py
• Scripts/Settings.py
• Utilities: Scripts/Utilities.py (shared helper functions)
• Local Data Storage:
• Scripts/Cache.json (categories, users, lookup dicts)
• Scripts/Transactions.json (expense/income records)
• Dependencies: requirements.txt (Python libraries, including CustomTkinter, matplotlib, etc.)
Architecture from README
• Modular “feature-per-file” design.
• JSON files act as the persistent Model.
• CustomTkinter components render the View; main.py orchestrates startup.
Main components
a. Frontend (GUI Layer)
• CustomTkinter Application (main.py)
• Dashboard View (Dashboard.py)
• Heatmap View (Heatmap.py)
• Tabular View (Tabular_view.py)
• Settings View (Settings.py)
b. Business Logic Layer
• Utilities Module (Utilities.py)
• Data Validation, Formatting, Category Management
c. Data Layer (Model)
• Local JSON Store (Cache.json, Transactions.json)
d. Assets
e. External Dependencies
• Python Standard Library
• Third-party libs: CustomTkinter, matplotlib, pandas (if used), etc.
Relationships & interactions
• main.py initializes the CustomTkinter app → loads the Utilities module → loads Cache.json into memory.
• User interactions in any View module → call functions in Utilities.py → read/write to JSON files.
• Visualization modules (Heatmap, Dashboard) query Transactions.json, build charts (matplotlib), and render via CustomTkinter.
• Settings module updates Cache.json (e.g., add/remove categories or users).
• Tabular view reads Transactions.json for tables, allows edits via Utilities.
Architectural patterns & principles
• MVC-style separation:
• Model: JSON files + Utilities for data access
• View: CustomTkinter widgets in each script
• Controller: main.py dispatches commands, views call Utilities
• Modular design: each feature in its own script for maintainability
• Offline-first local storage → no external DB or network dependency
Detail requirements
• Clear component names: e.g., “Dashboard.py (View)”
• Arrowheads showing direction of data flow & control