# nyasha2/missminutes architecture

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

- Interactive diagram: https://gitdiagram.com/nyasha2/missminutes
- Repository: https://github.com/nyasha2/missminutes

## Overview

##### Project type and purpose
- This is primarily a Python scheduling library ("missminutes") that implements constraint‐based task scheduling.
- It includes two CLI/demo scripts (demo_caltech_schedule.py, demo_simple_schedule.py) and a lightweight web demo (demo/server.py + HTML/CSS/JS).
- Purpose: Provide a reusable scheduler engine + optional demos that let users interact via command line or browser.

##### File structure
Top‐level
- missminutes/           ← core scheduling engine (modules for constraints, events, tasks, time domains, time profiles, solver)
- demo/                  ← web demo app
– server.py            ← small HTTP server (Flask or built‐in) exposing HTML templates + static assets
– templates/           ← HTML views (calendar.html, plan.html)
– static/              ← client‐side assets (components, JS, CSS)
- demo_*.py              ← CLI entry points for example schedules
- requirements.txt       ← Python dependencies
Patterns
- Core library is modular Python package (separation by domain concerns)
- Demo follows simple MVC: server (controller) → templates (view) + static (view assets)

##### README for additional insights
- Emphasizes automated scheduling with multiple constraints.

a. Main components
1. CLI / Demo Scripts
- demo_simple_schedule.py
- demo_caltech_schedule.py
2. Web Demo
- Server (demo/server.py)
- Templates (demo/templates)
- Static Frontend (JS/CSS/components)
3. Core Library (missminutes package)
- Constraint Solver (constraint_solver.py)
- Scheduler (scheduler.py)
- Domain Models:
– Events (events.py)
– Tasks (tasks.py)
– Tags (tags.py)
– Time Domain (timedomain.py)
– Time Profiles (timeprofile.py)
4. External / Runtime
- Python Interpreter
- Browser (for web demo)
- Data input (e.g., JSON/CSV or CLI arguments)
b. Relationships & interactions
- CLI scripts import & invoke missminutes.scheduler → constraint_solver → produce schedule → print to console
- Web demo: Browser issues HTTP requests → server.py routes → calls missminutes API → retrieves scheduling results → renders via templates + JS
- Constraint Solver module collaborates with domain model modules (events, tasks, timedomain, timeprofile)
c. Architectural patterns & design principles
- Modular library design: each domain concept in its own module
- Separation of concerns: core engine decoupled from any UI
- Demo uses MVC (server/controller, templates/view, static assets)
- The scheduling engine itself likely follows pipeline stages (parse input → build constraint graph → solve → output)
d. Key technologies/frameworks
- Python 3.x
- Jinja2 (if demo/templates use template engine)
- Vanilla JS + HTML/CSS for client
- (Optional) Flask or built‐in HTTPServer in server.py

##### Detailed element checklist
- Core library boundary
- Individual modules inside library
- Entry‐points (CLI scripts, server)
- Web frontend stack (templates + static folder)
- Data flow from user input to schedule output
- Annotations for key technologies (e.g., “uses Jinja2”, “vanilla JS”)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Entry Points"
        CLI1["demo_simple_schedule.py"]:::entry
        CLI2["demo_caltech_schedule.py"]:::entry
        Server["demo/server.py"]:::entry
    end

    Browser["Browser"]:::external

    CLI1 -->|"invokes"| Engine
    CLI2 -->|"invokes"| Engine
    Browser -->|"HTTP Request"| Server

    subgraph "missminutes Package"
        Pkg["missminutes/\n(__init__.py)"]:::core
        Engine["Scheduler Engine\n(missminutes/scheduler.py)"]:::core
        Solver["Constraint Solver\n(missminutes/constraint_solver.py)"]:::core
        Events["Events Module\n(missminutes/events.py)"]:::core
        Tasks["Tasks Module\n(missminutes/tasks.py)"]:::core
        Tags["Tags Module\n(missminutes/tags.py)"]:::core
        Domain["Time Domain\n(missminutes/timedomain.py)"]:::core
        Profile["Time Profiles\n(missminutes/timeprofile.py)"]:::core
    end

    Engine -->|"uses"| Solver
    Engine -->|"imports"| Events
    Engine -->|"imports"| Tasks
    Engine -->|"imports"| Tags
    Engine -->|"imports"| Domain
    Engine -->|"imports"| Profile
    Solver --> Events
    Solver --> Tasks

    subgraph "Web Demo UI"
        Templates["Templates\n(calendar.html, plan.html)"]:::ui
        StaticComp["Static Components\n(events-form.html, tasks-form.html)"]:::ui
        JS["JavaScript\n(plan.js, profiles.js, tabs.js, time_grid.js)"]:::ui
        CSS["CSS\n(calendar.css, components.css, forms.css, grid.css, main.css)"]:::ui
    end

    Server -->|"renders"| Templates
    Server -->|"serves"| StaticComp
    Server -->|"serves"| JS
    Server -->|"serves"| CSS
    Templates --> Browser
    StaticComp --> Browser
    JS --> Browser
    CSS --> Browser

    classDef entry fill:#FFA500,stroke:#333,stroke-width:1px
    classDef core fill:#87CEFA,stroke:#333,stroke-width:1px
    classDef ui fill:#90EE90,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px

    click CLI1 "https://github.com/nyasha2/missminutes/blob/main/demo_simple_schedule.py"
    click CLI2 "https://github.com/nyasha2/missminutes/blob/main/demo_caltech_schedule.py"
    click Server "https://github.com/nyasha2/missminutes/blob/main/demo/server.py"
    click Templates "https://github.com/nyasha2/missminutes/blob/main/demo/templates/calendar.html"
    click Templates "https://github.com/nyasha2/missminutes/blob/main/demo/templates/plan.html"
    click StaticComp "https://github.com/nyasha2/missminutes/blob/main/demo/static/components/events-form.html"
    click StaticComp "https://github.com/nyasha2/missminutes/blob/main/demo/static/components/tasks-form.html"
    click JS "https://github.com/nyasha2/missminutes/blob/main/demo/static/js/plan.js"
    click JS "https://github.com/nyasha2/missminutes/blob/main/demo/static/js/profiles.js"
    click JS "https://github.com/nyasha2/missminutes/blob/main/demo/static/js/tabs.js"
    click JS "https://github.com/nyasha2/missminutes/blob/main/demo/static/js/time_grid.js"
    click CSS "https://github.com/nyasha2/missminutes/blob/main/demo/static/styles/calendar.css"
    click CSS "https://github.com/nyasha2/missminutes/blob/main/demo/static/styles/components.css"
    click CSS "https://github.com/nyasha2/missminutes/blob/main/demo/static/styles/forms.css"
    click CSS "https://github.com/nyasha2/missminutes/blob/main/demo/static/styles/grid.css"
    click CSS "https://github.com/nyasha2/missminutes/blob/main/demo/static/styles/main.css"
    click Pkg "https://github.com/nyasha2/missminutes/blob/main/missminutes/__init__.py"
    click Engine "https://github.com/nyasha2/missminutes/blob/main/missminutes/scheduler.py"
    click Solver "https://github.com/nyasha2/missminutes/blob/main/missminutes/constraint_solver.py"
    click Events "https://github.com/nyasha2/missminutes/blob/main/missminutes/events.py"
    click Tasks "https://github.com/nyasha2/missminutes/blob/main/missminutes/tasks.py"
    click Tags "https://github.com/nyasha2/missminutes/blob/main/missminutes/tags.py"
    click Domain "https://github.com/nyasha2/missminutes/blob/main/missminutes/timedomain.py"
    click Profile "https://github.com/nyasha2/missminutes/blob/main/missminutes/timeprofile.py"
```
