# pumpkincrushed/edumaster-ai architecture

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

- Interactive diagram: https://gitdiagram.com/pumpkincrushed/edumaster-ai
- Repository: https://github.com/pumpkincrushed/edumaster-ai

## Overview

EduMaster AI is a Spanish-language academic writing assistant. Its implemented user workflow is selecting the writing-review tool, submitting a draft, receiving AI-generated comments, and optionally viewing an editable rewrite. The tree also advertises future academic, teaching, research, assessment, document, regulation, and assistant tools; settings marks them as coming soon, so they are shown as planned capabilities rather than implemented flows. The history database is likewise labeled a later phase. Edges reflect the app and revision excerpts or SOURCE INDEX references; unsampled modules are not assumed to be wired into the workflow.

Main entry points: [`EduMaster-AI/core/ai_engine.py`](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/ai_engine.py) (AI engine), [`EduMaster-AI/modules/revision.py`](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/modules/revision.py) (Writing review), [`EduMaster-AI/app.py`](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/app.py) (Streamlit app), [`EduMaster-AI/database/history.py`](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/database/history.py) (Revision history)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["User experience"]
  node_app["Streamlit app<br/>[app.py]"]
  node_revision["Writing review<br/>[revision.py]"]
end

subgraph group_ai["AI generation"]
  node_ai_engine["AI engine<br/>[ai_engine.py]"]
  node_gemini{{"Google Gemini"}}
  node_ai_response["AI response model<br/>[models.py]"]
  node_prompts["Shared prompts<br/>[prompts.py]"]
  node_settings["App settings<br/>[settings.py]"]
end

subgraph group_content["Content utilities"]
  node_reader["Document reader<br/>[document_reader.py]"]
  node_writer["Document writer<br/>[document_writer.py]"]
  node_text_processor["Text processing<br/>[text_processor.py]"]
  node_validator["Source validator"]
end

subgraph group_state["History and roadmap"]
  node_history["Revision history<br/>[history.py]"]
  node_database[("SQLite database<br/>[connection.py]")]
  node_planned_tools["Planned tools<br/>[settings.py]"]
end

node_student(("Student"))

node_student -->|"uses"| node_app
node_app -->|"routes to"| node_revision
node_revision -->|"requests generation"| node_ai_engine
node_ai_engine -->|"generates content"| node_gemini
node_ai_engine -->|"returns"| node_ai_response
node_ai_engine -->|"uses defaults"| node_prompts
node_ai_engine -->|"loads defaults"| node_settings
node_revision -->|"shows results"| node_student
node_history -->|"opens connection"| node_database

click node_app "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/app.py"
click node_revision "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/modules/revision.py"
click node_ai_engine "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/ai_engine.py"
click node_ai_response "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/config/models.py"
click node_prompts "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/config/prompts.py"
click node_settings "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/config/settings.py"
click node_reader "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/document_reader.py"
click node_writer "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/document_writer.py"
click node_text_processor "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/text_processor.py"
click node_validator "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/source_validator.py"
click node_history "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/database/history.py"
click node_database "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/database/connection.py"
click node_planned_tools "https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/config/settings.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_app,node_revision toneBlue
class node_ai_engine,node_gemini,node_ai_response,node_prompts,node_settings toneAmber
class node_reader,node_writer,node_text_processor,node_validator toneMint
class node_history,node_database,node_planned_tools toneRose
class node_student toneIndigo
```

## Components

### User experience

- [Streamlit app](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/app.py): `EduMaster-AI/app.py`
- [Writing review](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/modules/revision.py): `EduMaster-AI/modules/revision.py`

### AI generation

- [AI engine](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/ai_engine.py): `EduMaster-AI/core/ai_engine.py`
- **Google Gemini**
- [AI response model](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/config/models.py): `EduMaster-AI/config/models.py`
- [Shared prompts](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/config/prompts.py): `EduMaster-AI/config/prompts.py`
- [App settings](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/config/settings.py): `EduMaster-AI/config/settings.py`

### Content utilities

- [Document reader](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/document_reader.py): `EduMaster-AI/core/document_reader.py`
- [Document writer](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/document_writer.py): `EduMaster-AI/core/document_writer.py`
- [Text processing](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/text_processor.py): `EduMaster-AI/core/text_processor.py`
- [Source validator](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/core/source_validator.py): `EduMaster-AI/core/source_validator.py`

### History and roadmap

- [Revision history](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/database/history.py): `EduMaster-AI/database/history.py`
- [SQLite database](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/database/connection.py): `EduMaster-AI/database/connection.py`
- [Planned tools](https://github.com/pumpkincrushed/edumaster-ai/blob/main/EduMaster-AI/config/settings.py): `EduMaster-AI/config/settings.py`

### Other components

- **Student**

## Connections

- Student → Streamlit app: uses (evidence: `EduMaster-AI/app.py`)
- Streamlit app → Writing review: routes to (evidence: `EduMaster-AI/app.py`)
- Writing review → AI engine: requests generation (evidence: `EduMaster-AI/modules/revision.py`)
- AI engine → Google Gemini: generates content (evidence: `EduMaster-AI/core/ai_engine.py`)
- AI engine → AI response model: returns (evidence: `EduMaster-AI/core/ai_engine.py`)
- AI engine → Shared prompts: uses defaults (evidence: `EduMaster-AI/core/ai_engine.py`)
- AI engine → App settings: loads defaults (evidence: `EduMaster-AI/core/ai_engine.py`)
- Writing review → Student: shows results (evidence: `EduMaster-AI/modules/revision.py`)
- Revision history → SQLite database: opens connection (evidence: `EduMaster-AI/database/history.py`)
