# techcsispit/grade-tracker architecture

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

- Interactive diagram: https://gitdiagram.com/techcsispit/grade-tracker
- Repository: https://github.com/techcsispit/grade-tracker

## Overview

Grade Tracker is a dependency-free command-line gradebook. A user runs the module entry point, which starts the CLI; commands read or append CSV records, calculate grades or summaries, and can generate an HTML report. The README documents listing marks, student GPA summaries, subject averages, adding marks, and exporting a report. Calculation behavior is excerpted; the graph does not infer unshown validation or finer command-dispatch relationships.

Main entry points: [`grade_tracker/cli.py`](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/cli.py) (Grade commands), [`grade_tracker/export.py`](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/export.py) (HTML exporter), [`grade_tracker/__main__.py`](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/__main__.py) (Module entry), [`grade_tracker/calc.py`](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/calc.py) (Letter grades)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interface["Command line"]
  node_entry["Module entry<br/>[__main__.py]"]
  node_cli["Grade commands<br/>[cli.py]"]
end

subgraph group_logic["Grade calculations"]
  node_grading["Letter grades<br/>[calc.py]"]
  node_summaries["GPA and averages<br/>[calc.py]"]
end

subgraph group_records["Records and reports"]
  node_csv[("Grade records<br/>[grades.csv]")]
  node_exporter["HTML exporter<br/>[export.py]"]
  node_report["HTML report"]
end

node_user(("CLI user"))

node_user -->|"runs module"| node_entry
node_entry -->|"calls main"| node_cli
node_cli -->|"reads and appends"| node_csv
node_cli -->|"gets letter grades"| node_grading
node_cli -->|"gets GPA and averages"| node_summaries
node_cli -->|"calls build_html"| node_exporter
node_exporter -->|"gets letter grades"| node_grading
node_exporter -->|"gets GPA"| node_summaries
node_exporter -->|"writes report"| node_report
node_cli -->|"prints results"| node_user

click node_entry "https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/__main__.py"
click node_cli "https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/cli.py"
click node_grading "https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/calc.py"
click node_summaries "https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/calc.py"
click node_csv "https://github.com/techcsispit/grade-tracker/blob/main/data/grades.csv"
click node_exporter "https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/export.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_cli,node_user toneBlue
class node_grading,node_summaries toneAmber
class node_csv,node_exporter,node_report toneMint
```

## Components

### Command line

- [Module entry](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/__main__.py): `grade_tracker/__main__.py`
- [Grade commands](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/cli.py): `grade_tracker/cli.py`

### Grade calculations

- [Letter grades](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/calc.py): `grade_tracker/calc.py`
- [GPA and averages](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/calc.py): `grade_tracker/calc.py`

### Records and reports

- [Grade records](https://github.com/techcsispit/grade-tracker/blob/main/data/grades.csv): `data/grades.csv`
- [HTML exporter](https://github.com/techcsispit/grade-tracker/blob/main/grade_tracker/export.py): `grade_tracker/export.py`
- **HTML report**

### Other components

- **CLI user**

## Connections

- CLI user → Module entry: runs module (evidence: `README.md`)
- Module entry → Grade commands: calls main (evidence: `grade_tracker/__main__.py`)
- Grade commands → Grade records: reads and appends (evidence: `grade_tracker/cli.py`)
- Grade commands → Letter grades: gets letter grades (evidence: `grade_tracker/cli.py`)
- Grade commands → GPA and averages: gets GPA and averages (evidence: `grade_tracker/cli.py`)
- Grade commands → HTML exporter: calls build_html (evidence: `grade_tracker/cli.py`)
- HTML exporter → Letter grades: gets letter grades (evidence: `grade_tracker/export.py`)
- HTML exporter → GPA and averages: gets GPA (evidence: `grade_tracker/export.py`)
- HTML exporter → HTML report: writes report (evidence: `grade_tracker/export.py`)
- Grade commands → CLI user: prints results (evidence: `grade_tracker/cli.py`)
