# mrfrazer25/homework-tracker architecture

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

- Interactive diagram: https://gitdiagram.com/mrfrazer25/homework-tracker
- Repository: https://github.com/mrfrazer25/homework-tracker

## Overview

##### Project type and purpose
- This is a standalone desktop “full-stack” application (Python) with a graphical UI for tracking homework plus a locally-hosted chatbot assistant.
- Its purpose is to let students manage assignments (CRUD, calendar view, statistics) and interact with an NLU-powered assistant for study tips and scheduling help.

##### File structure
- Top-level
- main.py – application entry point
- requirements.txt, README.md, LICENSE
- src/
- core/ – business logic:
– assignment_manager.py (CRUD & query over assignments)
– data_handler.py (persistence to JSON files)
– chatbot.py (wrapping the NLU pipeline & memory)
– study_tips.py (encapsulates static tip logic)
- gui/ – UI layer:
– app.py (initializes window & tabs)
– *\_tab.py (Dashboard, Assignments, Calendar, Statistics, Chatbot)
– chat_history_dialog.py (view stored conversations)
- utils/ – cross-cutting helpers:
– helpers.py (date formatting, generic helpers)
– settings_manager.py (load/save user preferences)

##### README for additional insights
- GUI has five main views (dashboard, assignments, calendar, statistics, chat assistant).
- Chatbot uses Hugging Face transformers for intent/emotion detection, Langchain memory for conversation context, all on-device.
- Data (assignments.json, settings.json, chat_history.json) lives in a local data/ directory (gitignored).

##### Final reminders
- Every module that has distinct responsibility—even Helpers or SettingsManager.
- How the Chatbot Tab interacts with the Chatbot Engine and then with the model/memory.
- Entry point (main.py) is visible, illustrating app initialization and wiring of components.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Entry Point
    main["main.py\n(Entry Point)"]:::entry

    %% GUI Layer
    subgraph "GUI Layer"
        AppWindow["App Window\n(src/gui/app.py)"]:::gui
        DashboardTab["Dashboard Tab\n(src/gui/dashboard_tab.py)"]:::gui
        AssignmentsTab["Assignments Tab\n(src/gui/assignments_tab.py)"]:::gui
        CalendarTab["Calendar Tab\n(src/gui/calendar_tab.py)"]:::gui
        StatisticsTab["Statistics Tab\n(src/gui/statistics_tab.py)"]:::gui
        ChatbotTab["Chatbot Tab\n(src/gui/chatbot_tab.py)"]:::gui
        ChatHistoryDialog["Chat History Dialog\n(src/gui/chat_history_dialog.py)"]:::gui
    end

    %% Core Backend
    subgraph "Core Backend"
        AssignmentManager["AssignmentManager\n(src/core/assignment_manager.py)"]:::core
        DataHandler["DataHandler\n(src/core/data_handler.py)"]:::core
        ChatbotEngine["Chatbot Engine\n(src/core/chatbot.py)"]:::core
        StudyTips["StudyTips Module\n(src/core/study_tips.py)"]:::core
    end

    %% Utility Services
    subgraph "Utility Services"
        Helpers["Helpers\n(src/utils/helpers.py)"]:::util
        SettingsManager["SettingsManager\n(src/utils/settings_manager.py)"]:::util
    end

    %% Data Storage
    subgraph "Data Storage"
        AssignmentsJSON["assignments.json"]:::data
        SettingsJSON["settings.json"]:::data
        ChatHistoryJSON["chat_history.json"]:::data
    end

    %% External Models
    subgraph "External Models"
        Transformers["transformers\n(intent/emotion models)"]:::external
        Torch["torch"]:::external
        Langchain["langchain\n(memory & history)"]:::external
    end

    %% Connections - Initialization
    main -->|"initialize UI"| AppWindow

    %% GUI to Core
    AppWindow -->|"load Dashboard"| DashboardTab
    AppWindow -->|"load Assignments"| AssignmentsTab
    AppWindow -->|"load Calendar"| CalendarTab
    AppWindow -->|"load Statistics"| StatisticsTab
    AppWindow -->|"load Chatbot"| ChatbotTab

    DashboardTab -->|"fetch dashboard data"| AssignmentManager
    AssignmentsTab -->|"CRUD operations"| AssignmentManager
    CalendarTab -->|"fetch assignments by date"| AssignmentManager
    StatisticsTab -->|"compute metrics"| AssignmentManager
    ChatbotTab -->|"send user input"| ChatbotEngine
    ChatbotTab -->|"view history"| ChatHistoryDialog

    %% Core to Data Storage
    AssignmentManager -->|"read/write assignments"| DataHandler
    DataHandler -->|"persist/read JSON"| AssignmentsJSON

    SettingsManager -->|"load/save prefs"| SettingsJSON

    ChatbotEngine -->|"store conversation"| ChatHistoryJSON

    %% Chatbot Engine to External Models
    ChatbotEngine -->|"intent classification"| Transformers
    ChatbotEngine -->|"use models"| Torch
    ChatbotEngine -->|"memory I/O"| Langchain

    %% Utilities usage
    AssignmentManager -.->|"uses helpers"| Helpers
    DataHandler -.->|"uses helpers"| Helpers
    ChatbotEngine -.->|"uses settings"| SettingsManager
    ChatbotEngine -.->|"uses helpers"| Helpers
    AppWindow -.->|"load settings"| SettingsManager

    %% Click Events
    click main "https://github.com/mrfrazer25/homework-tracker/blob/main/main.py"
    click AppWindow "https://github.com/mrfrazer25/homework-tracker/blob/main/src/gui/app.py"
    click DashboardTab "https://github.com/mrfrazer25/homework-tracker/blob/main/src/gui/dashboard_tab.py"
    click AssignmentsTab "https://github.com/mrfrazer25/homework-tracker/blob/main/src/gui/assignments_tab.py"
    click CalendarTab "https://github.com/mrfrazer25/homework-tracker/blob/main/src/gui/calendar_tab.py"
    click StatisticsTab "https://github.com/mrfrazer25/homework-tracker/blob/main/src/gui/statistics_tab.py"
    click ChatbotTab "https://github.com/mrfrazer25/homework-tracker/blob/main/src/gui/chatbot_tab.py"
    click ChatHistoryDialog "https://github.com/mrfrazer25/homework-tracker/blob/main/src/gui/chat_history_dialog.py"
    click AssignmentManager "https://github.com/mrfrazer25/homework-tracker/blob/main/src/core/assignment_manager.py"
    click DataHandler "https://github.com/mrfrazer25/homework-tracker/blob/main/src/core/data_handler.py"
    click ChatbotEngine "https://github.com/mrfrazer25/homework-tracker/blob/main/src/core/chatbot.py"
    click StudyTips "https://github.com/mrfrazer25/homework-tracker/blob/main/src/core/study_tips.py"
    click Helpers "https://github.com/mrfrazer25/homework-tracker/blob/main/src/utils/helpers.py"
    click SettingsManager "https://github.com/mrfrazer25/homework-tracker/blob/main/src/utils/settings_manager.py"

    %% Styles
    classDef entry fill:#d9d9d9,stroke:#333,stroke-width:1px
    classDef gui fill:#cce5ff,stroke:#004085,stroke-width:1px
    classDef core fill:#ccffcc,stroke:#155724,stroke-width:1px
    classDef util fill:#fff2cc,stroke:#856404,stroke-width:1px
    classDef data fill:#e0e0e0,stroke:#6c757d,stroke-width:1px
    classDef external fill:#ffe0b2,stroke:#e65100,stroke-width:1px
```
