# kimoz1994/pdf-reader architecture

> Architecture diagram of the GitHub repository kimoz1994/pdf-reader, 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/kimoz1994/pdf-reader
- Repository: https://github.com/kimoz1994/pdf-reader

## Overview

PDF Reader is a local study application: a learner opens a library document, reads and captures passages or images as persistent Extracts, revisits and edits them, and can turn them into flashcards for FSRS review. MainWindow coordinates the four views; service modules provide persistence, selection/layout helpers, scheduling, export, and settings. Edges are limited to README-documented routing and relationships visible in the excerpts or SOURCE INDEX; some view internals were not sampled.

Main entry points: [`pdf_reader/gui_app/main_window.py`](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/main_window.py) (Main window), [`pdf_reader/gui_app/views/pdf_reader_view.py`](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/pdf_reader_view.py) (PDF reader), [`pdf_reader/gui_app/views/extracts_view.py`](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/extracts_view.py) (Extracts editor), [`pdf_reader/gui_app/views/flashcards_view.py`](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/flashcards_view.py) (Flashcard review)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Desktop app"]
  node_entry["App entry<br/>[main.py]"]
  node_shell["Main window<br/>[main_window.py]"]
end

subgraph group_reading["PDF reading"]
  node_library["PDF library<br/>[library_view.py]"]
  node_reader["PDF reader<br/>[pdf_reader_view.py]"]
end

subgraph group_study["Study workflow"]
  node_extracts["Extracts editor<br/>[extracts_view.py]"]
  node_flashcards["Flashcard review<br/>[flashcards_view.py]"]
  node_answer["Answer renderer"]
end

subgraph group_services["Application services"]
  node_element["Element detection"]
  node_geometry["Page geometry<br/>[pdf_geometry.py]"]
  node_snapshot["Selection snapshot"]
  node_store["Study data store<br/>[extract_store.py]"]
  node_export["Data export<br/>[export_data.py]"]
  node_scheduler["FSRS scheduler<br/>[fsrs_scheduler.py]"]
  node_settings["Window settings<br/>[window_settings.py]"]
  node_perf["Performance logging<br/>[perf_log.py]"]
end

node_learner(("Learner"))
node_pdf["PDF document"]
node_database[("Local SQLite data")]

node_learner -->|"launches"| node_entry
node_entry -->|"creates"| node_shell
node_entry -->|"creates icon"| node_settings
node_entry -->|"checks logging"| node_perf
node_shell -->|"shows view"| node_library
node_shell -->|"shows view"| node_reader
node_shell -->|"shows view"| node_extracts
node_shell -->|"shows view"| node_flashcards
node_library -->|"stores library"| node_database
node_library -->|"opens document"| node_reader
node_reader -->|"renders"| node_pdf
node_reader -->|"detects selections"| node_element
node_reader -->|"maps page regions"| node_geometry
node_reader -->|"reads and saves extracts"| node_store
node_reader -.->|"opens extracts view"| node_extracts
node_extracts -->|"loads and edits"| node_store
node_extracts -->|"builds snapshots"| node_snapshot
node_extracts -->|"exports data"| node_export
node_extracts -.->|"starts review"| node_flashcards
node_store -->|"reads and writes"| node_database
node_flashcards -->|"loads and records cards"| node_store
node_flashcards -->|"rates cards"| node_scheduler
node_flashcards -->|"renders answers"| node_answer
node_shell -->|"restores window"| node_settings
node_shell -->|"records timings"| node_perf

click node_entry "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/main.py"
click node_shell "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/main_window.py"
click node_library "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/library_view.py"
click node_reader "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/pdf_reader_view.py"
click node_element "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/element_detector.py"
click node_geometry "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/pdf_geometry.py"
click node_extracts "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/extracts_view.py"
click node_snapshot "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/selection_snapshot.py"
click node_store "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/extract_store.py"
click node_export "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/export_data.py"
click node_flashcards "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/flashcards_view.py"
click node_answer "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/flashcard_answer.py"
click node_scheduler "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/fsrs_scheduler.py"
click node_settings "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/window_settings.py"
click node_perf "https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/perf_log.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_shell toneBlue
class node_library,node_reader,node_database toneAmber
class node_extracts,node_flashcards,node_answer toneMint
class node_element,node_geometry,node_snapshot,node_store,node_export,node_scheduler,node_settings,node_perf toneRose
class node_learner,node_pdf toneIndigo
```

## Components

### Desktop app

- [App entry](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/main.py): `pdf_reader/gui_app/main.py`
- [Main window](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/main_window.py): `pdf_reader/gui_app/main_window.py`

### PDF reading

- [PDF library](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/library_view.py): `pdf_reader/gui_app/views/library_view.py`
- [PDF reader](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/pdf_reader_view.py): `pdf_reader/gui_app/views/pdf_reader_view.py`

### Study workflow

- [Extracts editor](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/extracts_view.py): `pdf_reader/gui_app/views/extracts_view.py`
- [Flashcard review](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/flashcards_view.py): `pdf_reader/gui_app/views/flashcards_view.py`
- [Answer renderer](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/views/flashcard_answer.py): `pdf_reader/gui_app/views/flashcard_answer.py`

### Application services

- [Element detection](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/element_detector.py): `pdf_reader/gui_app/services/element_detector.py`
- [Page geometry](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/pdf_geometry.py): `pdf_reader/gui_app/services/pdf_geometry.py`
- [Selection snapshot](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/selection_snapshot.py): `pdf_reader/gui_app/services/selection_snapshot.py`
- [Study data store](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/extract_store.py): `pdf_reader/gui_app/services/extract_store.py`
- [Data export](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/export_data.py): `pdf_reader/gui_app/services/export_data.py`
- [FSRS scheduler](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/fsrs_scheduler.py): `pdf_reader/gui_app/services/fsrs_scheduler.py`
- [Window settings](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/window_settings.py): `pdf_reader/gui_app/services/window_settings.py`
- [Performance logging](https://github.com/kimoz1994/pdf-reader/blob/master/pdf_reader/gui_app/services/perf_log.py): `pdf_reader/gui_app/services/perf_log.py`

### Other components

- **Learner**
- **PDF document**
- **Local SQLite data**

## Connections

- Learner → App entry: launches (evidence: `README.md`)
- App entry → Main window: creates (evidence: `pdf_reader/gui_app/main.py`)
- App entry → Window settings: creates icon (evidence: `pdf_reader/gui_app/main.py`)
- App entry → Performance logging: checks logging (evidence: `pdf_reader/gui_app/main.py`)
- Main window → PDF library: shows view (evidence: `README.md`)
- Main window → PDF reader: shows view (evidence: `README.md`)
- Main window → Extracts editor: shows view (evidence: `README.md`)
- Main window → Flashcard review: shows view (evidence: `README.md`)
- PDF library → Local SQLite data: stores library (evidence: `pdf_reader/gui_app/views/library_view.py`)
- PDF library → PDF reader: opens document (evidence: `README.md`)
- PDF reader → PDF document: renders (evidence: `README.md`)
- PDF reader → Element detection: detects selections (evidence: `pdf_reader/gui_app/views/pdf_reader_view.py`)
- PDF reader → Page geometry: maps page regions (evidence: `pdf_reader/gui_app/views/pdf_reader_view.py`)
- PDF reader → Study data store: reads and saves extracts (evidence: `pdf_reader/gui_app/views/pdf_reader_view.py`)
- PDF reader → Extracts editor: opens extracts view
- Extracts editor → Study data store: loads and edits (evidence: `pdf_reader/gui_app/views/extracts_view.py`)
- Extracts editor → Selection snapshot: builds snapshots (evidence: `pdf_reader/gui_app/views/extracts_view.py`)
- Extracts editor → Data export: exports data (evidence: `pdf_reader/gui_app/views/extracts_view.py`)
- Extracts editor → Flashcard review: starts review
- Study data store → Local SQLite data: reads and writes (evidence: `pdf_reader/gui_app/services/extract_store.py`)
- Flashcard review → Study data store: loads and records cards (evidence: `pdf_reader/gui_app/views/flashcards_view.py`)
- Flashcard review → FSRS scheduler: rates cards (evidence: `pdf_reader/gui_app/views/flashcards_view.py`)
- Flashcard review → Answer renderer: renders answers (evidence: `pdf_reader/gui_app/views/flashcards_view.py`)
- Main window → Window settings: restores window (evidence: `pdf_reader/gui_app/main_window.py`)
- Main window → Performance logging: records timings (evidence: `pdf_reader/gui_app/main_window.py`)
