# lordkelwin/class-record-generator-new architecture

> Architecture diagram of the GitHub repository lordkelwin/class-record-generator-new, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lordkelwin/class-record-generator-new
- Repository: https://github.com/lordkelwin/class-record-generator-new

## Overview

This is a Flask-based USeP engineering OBE platform. Faculty author syllabi against program and course catalogs, submit them for sequential committee and institutional approval, then use approved course data for class-record setup, per-CLO scoring, grade computation, and official exports. The README documents these lifecycle stages and reports; the source index and excerpts identify key app modules, stores, and generators. Some secondary capabilities are represented from the README or file tree, so their internal links are dashed where implementation wiring was not shown.

Main entry points: [`app.py`](https://github.com/lordkelwin/class-record-generator-new/blob/main/app.py) (Web application), [`courses_store.py`](https://github.com/lordkelwin/class-record-generator-new/blob/main/courses_store.py) (Course store), [`syllabus_workflow.py`](https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_workflow.py) (Syllabus workflow), [`db_persistence.py`](https://github.com/lordkelwin/class-record-generator-new/blob/main/db_persistence.py) (Relational persistence)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_authoring["Syllabus authoring"]
  node_catalog[("Academic catalogs<br/>[catalog_data.py]")]
  node_programs[("Program outcomes")]
  node_course_catalogs[("Program course catalogs<br/>[courses_ee.py]")]
  node_curriculum_access["Curriculum access"]
  node_syllabus_parse["Syllabus parsing<br/>[syllabus_parser.py]"]
  node_syllabus_model["Syllabus and assessment models<br/>[models.py]"]
end

subgraph group_approval["Review and approval"]
  node_syllabus_flow["Syllabus workflow"]
  node_evaluation_form["Review evaluation form"]
  node_notifications["Workflow notifications"]
end

subgraph group_records["Class records"]
  node_class_workflow["Class-record workflow"]
  node_student_store[("Student portal and roster<br/>[student_store.py]")]
  node_gradebook["Gradebook exports<br/>[excel_generator.py]"]
end

subgraph group_insights["Reports and insights"]
  node_syllabus_pdf["Syllabus PDF"]
  node_clo_pdf["CLO assessment PDF"]
  node_clo_excel["CLO assessment spreadsheet"]
  node_oversight["Oversight reports"]
  node_cqi["Continuous improvement analysis<br/>[cqi_engine.py]"]
end

subgraph group_platform["Identity and data"]
  node_course_store[("Course store<br/>[courses_store.py]")]
  node_auth["Authentication and roles<br/>[auth.py]"]
  node_persistence[("Relational persistence<br/>[db_persistence.py]")]
  node_firebase[("Firebase persistence")]
end

node_faculty(("Faculty and reviewers"))
node_webapp["Web application<br/>[app.py]"]
node_browser(("Browser user"))

node_browser -->|"uses"| node_webapp
node_webapp -->|"authenticates"| node_auth
node_faculty -->|"authors and submits"| node_webapp
node_webapp -->|"loads catalog data"| node_catalog
node_webapp -->|"loads program structures"| node_programs
node_catalog -->|"includes catalogs"| node_course_catalogs
node_course_catalogs -->|"may refresh courses"| node_curriculum_access
node_webapp -->|"parses syllabi"| node_syllabus_parse
node_webapp -->|"uses models"| node_syllabus_model
node_webapp -->|"routes workflow actions"| node_syllabus_flow
node_webapp -->|"serves review form"| node_evaluation_form
node_syllabus_flow -->|"resolves authors"| node_course_store
node_webapp -->|"saves course documents"| node_course_store
node_webapp -.->|"sends notifications"| node_notifications
node_webapp -->|"routes record actions"| node_class_workflow
node_class_workflow -->|"checks approval"| node_syllabus_flow
node_webapp -->|"handles student records"| node_student_store
node_webapp -->|"generates grade exports"| node_gradebook
node_webapp -->|"generates syllabus PDF"| node_syllabus_pdf
node_webapp -->|"generates CLO report"| node_clo_pdf
node_webapp -->|"generates CLO spreadsheet"| node_clo_excel
node_webapp -->|"generates oversight reports"| node_oversight
node_course_store -->|"stores course data"| node_persistence
node_student_store -->|"stores student data"| node_persistence
node_persistence -->|"delegates when configured"| node_firebase
node_course_store -.->|"supplies analysis data"| node_cqi
node_webapp -.->|"provides analytics"| node_cqi

click node_webapp "https://github.com/lordkelwin/class-record-generator-new/blob/main/app.py"
click node_catalog "https://github.com/lordkelwin/class-record-generator-new/blob/main/catalog_data.py"
click node_programs "https://github.com/lordkelwin/class-record-generator-new/blob/main/program_structures.py"
click node_course_catalogs "https://github.com/lordkelwin/class-record-generator-new/blob/main/program_catalogs/courses_ee.py"
click node_curriculum_access "https://github.com/lordkelwin/class-record-generator-new/blob/main/accdb_curriculum.py"
click node_syllabus_parse "https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_parser.py"
click node_syllabus_model "https://github.com/lordkelwin/class-record-generator-new/blob/main/models.py"
click node_syllabus_flow "https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_workflow.py"
click node_evaluation_form "https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_evaluation_form.py"
click node_notifications "https://github.com/lordkelwin/class-record-generator-new/blob/main/notification_service.py"
click node_course_store "https://github.com/lordkelwin/class-record-generator-new/blob/main/courses_store.py"
click node_class_workflow "https://github.com/lordkelwin/class-record-generator-new/blob/main/class_record_workflow.py"
click node_student_store "https://github.com/lordkelwin/class-record-generator-new/blob/main/student_store.py"
click node_gradebook "https://github.com/lordkelwin/class-record-generator-new/blob/main/excel_generator.py"
click node_syllabus_pdf "https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_pdf_generator.py"
click node_clo_pdf "https://github.com/lordkelwin/class-record-generator-new/blob/main/clo_report_pdf_generator.py"
click node_clo_excel "https://github.com/lordkelwin/class-record-generator-new/blob/main/clo_evaluation_excel_generator.py"
click node_oversight "https://github.com/lordkelwin/class-record-generator-new/blob/main/oversight_report_generator.py"
click node_cqi "https://github.com/lordkelwin/class-record-generator-new/blob/main/cqi_engine.py"
click node_auth "https://github.com/lordkelwin/class-record-generator-new/blob/main/auth.py"
click node_persistence "https://github.com/lordkelwin/class-record-generator-new/blob/main/db_persistence.py"
click node_firebase "https://github.com/lordkelwin/class-record-generator-new/blob/main/firebase_persistence.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_catalog,node_programs,node_course_catalogs,node_curriculum_access,node_syllabus_parse,node_syllabus_model,node_faculty,node_browser toneBlue
class node_syllabus_flow,node_evaluation_form,node_notifications toneAmber
class node_class_workflow,node_student_store,node_gradebook toneMint
class node_syllabus_pdf,node_clo_pdf,node_clo_excel,node_oversight,node_cqi toneRose
class node_course_store,node_auth,node_persistence,node_firebase toneIndigo
class node_webapp toneTeal
```

## Components

### Syllabus authoring

- [Academic catalogs](https://github.com/lordkelwin/class-record-generator-new/blob/main/catalog_data.py): `catalog_data.py`
- [Program outcomes](https://github.com/lordkelwin/class-record-generator-new/blob/main/program_structures.py): `program_structures.py`
- [Program course catalogs](https://github.com/lordkelwin/class-record-generator-new/blob/main/program_catalogs/courses_ee.py): `program_catalogs/courses_ee.py`
- [Curriculum access](https://github.com/lordkelwin/class-record-generator-new/blob/main/accdb_curriculum.py): `accdb_curriculum.py`
- [Syllabus parsing](https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_parser.py): `syllabus_parser.py`
- [Syllabus and assessment models](https://github.com/lordkelwin/class-record-generator-new/blob/main/models.py): `models.py`

### Review and approval

- [Syllabus workflow](https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_workflow.py): `syllabus_workflow.py`
- [Review evaluation form](https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_evaluation_form.py): `syllabus_evaluation_form.py`
- [Workflow notifications](https://github.com/lordkelwin/class-record-generator-new/blob/main/notification_service.py): `notification_service.py`

### Class records

- [Class-record workflow](https://github.com/lordkelwin/class-record-generator-new/blob/main/class_record_workflow.py): `class_record_workflow.py`
- [Student portal and roster](https://github.com/lordkelwin/class-record-generator-new/blob/main/student_store.py): `student_store.py`
- [Gradebook exports](https://github.com/lordkelwin/class-record-generator-new/blob/main/excel_generator.py): `excel_generator.py`

### Reports and insights

- [Syllabus PDF](https://github.com/lordkelwin/class-record-generator-new/blob/main/syllabus_pdf_generator.py): `syllabus_pdf_generator.py`
- [CLO assessment PDF](https://github.com/lordkelwin/class-record-generator-new/blob/main/clo_report_pdf_generator.py): `clo_report_pdf_generator.py`
- [CLO assessment spreadsheet](https://github.com/lordkelwin/class-record-generator-new/blob/main/clo_evaluation_excel_generator.py): `clo_evaluation_excel_generator.py`
- [Oversight reports](https://github.com/lordkelwin/class-record-generator-new/blob/main/oversight_report_generator.py): `oversight_report_generator.py`
- [Continuous improvement analysis](https://github.com/lordkelwin/class-record-generator-new/blob/main/cqi_engine.py): `cqi_engine.py`

### Identity and data

- [Course store](https://github.com/lordkelwin/class-record-generator-new/blob/main/courses_store.py): `courses_store.py`
- [Authentication and roles](https://github.com/lordkelwin/class-record-generator-new/blob/main/auth.py): `auth.py`
- [Relational persistence](https://github.com/lordkelwin/class-record-generator-new/blob/main/db_persistence.py): `db_persistence.py`
- [Firebase persistence](https://github.com/lordkelwin/class-record-generator-new/blob/main/firebase_persistence.py): `firebase_persistence.py`

### Other components

- **Faculty and reviewers**
- [Web application](https://github.com/lordkelwin/class-record-generator-new/blob/main/app.py): `app.py`
- **Browser user**

## Connections

- Browser user → Web application: uses (evidence: `README.md`)
- Web application → Authentication and roles: authenticates (evidence: `app.py`)
- Faculty and reviewers → Web application: authors and submits (evidence: `README.md`)
- Web application → Academic catalogs: loads catalog data (evidence: `app.py`)
- Web application → Program outcomes: loads program structures (evidence: `app.py`)
- Academic catalogs → Program course catalogs: includes catalogs (evidence: `catalog_data.py`)
- Program course catalogs → Curriculum access: may refresh courses (evidence: `program_catalogs/courses_ee.py`)
- Web application → Syllabus parsing: parses syllabi (evidence: `app.py`)
- Web application → Syllabus and assessment models: uses models (evidence: `app.py`)
- Web application → Syllabus workflow: routes workflow actions (evidence: `app.py`)
- Web application → Review evaluation form: serves review form (evidence: `app.py`)
- Syllabus workflow → Course store: resolves authors (evidence: `syllabus_workflow.py`)
- Web application → Course store: saves course documents (evidence: `app.py`)
- Web application → Workflow notifications: sends notifications (evidence: `app.py`)
- Web application → Class-record workflow: routes record actions (evidence: `app.py`)
- Class-record workflow → Syllabus workflow: checks approval (evidence: `class_record_workflow.py`)
- Web application → Student portal and roster: handles student records (evidence: `app.py`)
- Web application → Gradebook exports: generates grade exports (evidence: `app.py`)
- Web application → Syllabus PDF: generates syllabus PDF (evidence: `app.py`)
- Web application → CLO assessment PDF: generates CLO report (evidence: `app.py`)
- Web application → CLO assessment spreadsheet: generates CLO spreadsheet (evidence: `app.py`)
- Web application → Oversight reports: generates oversight reports (evidence: `app.py`)
- Course store → Relational persistence: stores course data (evidence: `courses_store.py`)
- Student portal and roster → Relational persistence: stores student data (evidence: `student_store.py`)
- Relational persistence → Firebase persistence: delegates when configured (evidence: `db_persistence.py`)
- Course store → Continuous improvement analysis: supplies analysis data
- Web application → Continuous improvement analysis: provides analytics (evidence: `app.py`)
