# hiroi-sora/umi-ocr architecture

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

- Interactive diagram: https://gitdiagram.com/hiroi-sora/umi-ocr
- Repository: https://github.com/hiroi-sora/umi-ocr

## Overview

Umi-OCR is an offline desktop OCR application with screenshot, batch-image, document, and QR-code workflows, plus command-line and HTTP interfaces. Users work through configurable tabs; image and document tasks feed OCR and text-layout processing, with results exportable in several formats. The graph includes the major README capabilities and central indexed modules. Some UI, server, and QR wiring was not sampled, so those relationships are left unverified rather than presented as observed calls.

Main entry points: [`UmiOCR-data/py_src/run.py`](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/run.py) (Desktop UI), [`UmiOCR-data/py_src/mission/mission_ocr.py`](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/mission_ocr.py) (Image OCR Tasks), [`UmiOCR-data/py_src/mission/mission_doc.py`](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/mission_doc.py) (Document Tasks), [`UmiOCR-data/py_src/tag_pages/BatchDOC.py`](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/BatchDOC.py) (Document Tab)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui_capture["UI and Capture"]
  node_desktop["Desktop UI<br/>[run.py]"]
  node_tag_pages["Feature Tabs"]
  node_screenshot["Screenshot Capture"]
  node_image_store["Image Provider<br/>[image_provider.py]"]
  node_batch_ui["Batch OCR Tab<br/>[BatchOCR.py]"]
  node_doc_ui["Document Tab<br/>[BatchDOC.py]"]
  node_screenshot_ui["Screenshot Tab<br/>[ScreenshotOCR.py]"]
end

subgraph group_tasks["Task Processing"]
  node_mission_base["Mission Scheduler<br/>[mission.py]"]
  node_image_mission["Image OCR Tasks<br/>[mission_ocr.py]"]
  node_doc_mission["Document Tasks<br/>[mission_doc.py]"]
  node_doc_preview["Document Preview"]
  node_qr["QR Tools<br/>[QRCode.py]"]
end

subgraph group_ocr["OCR and Export"]
  node_layout["Layout Parsers<br/>[paragraph_parse.py]"]
  node_line_layout["Line Parsing"]
  node_ocr_api["OCR API<br/>[__init__.py]"]
  node_export["Result Export"]
end

subgraph group_interfaces["External Interfaces"]
  node_cli["Command Client<br/>[cmd_client.py]"]
  node_http["HTTP Services<br/>[ocr_server.py]"]
end

subgraph group_runtime["Runtime and Settings"]
  node_plugins["OCR Plugins"]
  node_event_bus["Event Bus<br/>[pubsub_service.py]"]
  node_keyboard["Keyboard Hooks<br/>[keyboard.py]"]
  node_settings["Global Settings<br/>[pre_configs.py]"]
  node_startup["Application Entry<br/>[main.py]"]
end

node_user(("User"))

node_user -->|"uses"| node_desktop
node_desktop -->|"registers tabs"| node_tag_pages
node_user -->|"starts capture"| node_screenshot_ui
node_user -->|"selects images"| node_batch_ui
node_user -->|"selects documents"| node_doc_ui
node_user -->|"scans or generates"| node_qr
node_screenshot -->|"stores captures"| node_image_store
node_screenshot_ui -.->|"requests capture"| node_screenshot
node_batch_ui -.->|"submits images"| node_image_mission
node_doc_ui -->|"submits documents"| node_doc_mission
node_doc_preview -->|"requests OCR"| node_doc_mission
node_doc_mission -->|"extends"| node_mission_base
node_image_mission -->|"extends"| node_mission_base
node_image_mission -->|"calls engine"| node_ocr_api
node_doc_mission -->|"recognizes pages"| node_image_mission
node_image_mission -.->|"parses results"| node_layout
node_doc_mission -->|"parses results"| node_layout
node_line_layout -->|"uses paragraph rules"| node_layout
node_image_mission -.->|"writes results"| node_export
node_doc_ui -->|"exports documents"| node_export
node_plugins -->|"initializes plugins"| node_ocr_api
node_user -->|"sends commands"| node_cli
node_cli -.->|"sends requests"| node_http
node_user -->|"calls API"| node_http
node_startup -->|"starts application"| node_desktop
node_desktop -->|"registers connector"| node_event_bus
node_desktop -->|"registers connector"| node_keyboard
node_desktop -.->|"loads configuration"| node_settings

click node_desktop "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/run.py"
click node_tag_pages "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/tag_pages_connector.py"
click node_screenshot "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/image_controller/screenshot_controller.py"
click node_image_store "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/image_controller/image_provider.py"
click node_mission_base "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/mission.py"
click node_image_mission "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/mission_ocr.py"
click node_doc_mission "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/mission_doc.py"
click node_doc_preview "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/doc_preview_connector.py"
click node_layout "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/ocr/tbpu/parser_tools/paragraph_parse.py"
click node_line_layout "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/ocr/tbpu/parser_single_line.py"
click node_ocr_api "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/ocr/api/__init__.py"
click node_plugins "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/plugins_controller/plugins_controller.py"
click node_export "https://github.com/hiroi-sora/umi-ocr/tree/main/UmiOCR-data/py_src/ocr/output"
click node_qr "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/QRCode.py"
click node_batch_ui "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/BatchOCR.py"
click node_doc_ui "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/BatchDOC.py"
click node_screenshot_ui "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/ScreenshotOCR.py"
click node_cli "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/server/cmd_client.py"
click node_http "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/server/ocr_server.py"
click node_event_bus "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/event_bus/pubsub_service.py"
click node_keyboard "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/event_bus/key_mouse/keyboard.py"
click node_settings "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/utils/pre_configs.py"
click node_startup "https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/main.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_desktop,node_tag_pages,node_screenshot,node_image_store,node_batch_ui,node_doc_ui,node_screenshot_ui,node_user toneBlue
class node_mission_base,node_image_mission,node_doc_mission,node_doc_preview,node_qr toneAmber
class node_layout,node_line_layout,node_ocr_api,node_export toneMint
class node_cli,node_http toneRose
class node_plugins,node_event_bus,node_keyboard,node_settings,node_startup toneIndigo
```

## Components

### UI and Capture

- [Desktop UI](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/run.py): `UmiOCR-data/py_src/run.py`
- [Feature Tabs](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/tag_pages_connector.py): `UmiOCR-data/py_src/tag_pages/tag_pages_connector.py`
- [Screenshot Capture](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/image_controller/screenshot_controller.py): `UmiOCR-data/py_src/image_controller/screenshot_controller.py`
- [Image Provider](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/image_controller/image_provider.py): `UmiOCR-data/py_src/image_controller/image_provider.py`
- [Batch OCR Tab](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/BatchOCR.py): `UmiOCR-data/py_src/tag_pages/BatchOCR.py`
- [Document Tab](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/BatchDOC.py): `UmiOCR-data/py_src/tag_pages/BatchDOC.py`
- [Screenshot Tab](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/ScreenshotOCR.py): `UmiOCR-data/py_src/tag_pages/ScreenshotOCR.py`

### Task Processing

- [Mission Scheduler](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/mission.py): `UmiOCR-data/py_src/mission/mission.py`
- [Image OCR Tasks](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/mission_ocr.py): `UmiOCR-data/py_src/mission/mission_ocr.py`
- [Document Tasks](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/mission_doc.py): `UmiOCR-data/py_src/mission/mission_doc.py`
- [Document Preview](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/mission/doc_preview_connector.py): `UmiOCR-data/py_src/mission/doc_preview_connector.py`
- [QR Tools](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/tag_pages/QRCode.py): `UmiOCR-data/py_src/tag_pages/QRCode.py`

### OCR and Export

- [Layout Parsers](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/ocr/tbpu/parser_tools/paragraph_parse.py): `UmiOCR-data/py_src/ocr/tbpu/parser_tools/paragraph_parse.py`
- [Line Parsing](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/ocr/tbpu/parser_single_line.py): `UmiOCR-data/py_src/ocr/tbpu/parser_single_line.py`
- [OCR API](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/ocr/api/__init__.py): `UmiOCR-data/py_src/ocr/api/__init__.py`
- [Result Export](https://github.com/hiroi-sora/umi-ocr/tree/main/UmiOCR-data/py_src/ocr/output): `UmiOCR-data/py_src/ocr/output`

### External Interfaces

- [Command Client](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/server/cmd_client.py): `UmiOCR-data/py_src/server/cmd_client.py`
- [HTTP Services](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/server/ocr_server.py): `UmiOCR-data/py_src/server/ocr_server.py`

### Runtime and Settings

- [OCR Plugins](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/plugins_controller/plugins_controller.py): `UmiOCR-data/py_src/plugins_controller/plugins_controller.py`
- [Event Bus](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/event_bus/pubsub_service.py): `UmiOCR-data/py_src/event_bus/pubsub_service.py`
- [Keyboard Hooks](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/event_bus/key_mouse/keyboard.py): `UmiOCR-data/py_src/event_bus/key_mouse/keyboard.py`
- [Global Settings](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/py_src/utils/pre_configs.py): `UmiOCR-data/py_src/utils/pre_configs.py`
- [Application Entry](https://github.com/hiroi-sora/umi-ocr/blob/main/UmiOCR-data/main.py): `UmiOCR-data/main.py`

### Other components

- **User**

## Connections

- User → Desktop UI: uses
- Desktop UI → Feature Tabs: registers tabs (evidence: `UmiOCR-data/py_src/run.py`)
- User → Screenshot Tab: starts capture
- User → Batch OCR Tab: selects images
- User → Document Tab: selects documents
- User → QR Tools: scans or generates
- Screenshot Capture → Image Provider: stores captures (evidence: `UmiOCR-data/py_src/image_controller/screenshot_controller.py`)
- Screenshot Tab → Screenshot Capture: requests capture
- Batch OCR Tab → Image OCR Tasks: submits images
- Document Tab → Document Tasks: submits documents (evidence: `UmiOCR-data/py_src/tag_pages/BatchDOC.py`)
- Document Preview → Document Tasks: requests OCR (evidence: `UmiOCR-data/py_src/mission/doc_preview_connector.py`)
- Document Tasks → Mission Scheduler: extends (evidence: `UmiOCR-data/py_src/mission/mission_doc.py`)
- Image OCR Tasks → Mission Scheduler: extends (evidence: `UmiOCR-data/py_src/mission/mission_ocr.py`)
- Image OCR Tasks → OCR API: calls engine (evidence: `UmiOCR-data/py_src/mission/mission_ocr.py`)
- Document Tasks → Image OCR Tasks: recognizes pages (evidence: `UmiOCR-data/py_src/mission/mission_doc.py`)
- Image OCR Tasks → Layout Parsers: parses results
- Document Tasks → Layout Parsers: parses results (evidence: `UmiOCR-data/py_src/mission/mission_doc.py`)
- Line Parsing → Layout Parsers: uses paragraph rules (evidence: `UmiOCR-data/py_src/ocr/tbpu/parser_single_line.py`)
- Image OCR Tasks → Result Export: writes results
- Document Tab → Result Export: exports documents (evidence: `UmiOCR-data/py_src/tag_pages/BatchDOC.py`)
- OCR Plugins → OCR API: initializes plugins (evidence: `UmiOCR-data/py_src/plugins_controller/plugins_controller.py`)
- User → Command Client: sends commands
- Command Client → HTTP Services: sends requests
- User → HTTP Services: calls API
- Application Entry → Desktop UI: starts application (evidence: `UmiOCR-data/main.py`)
- Desktop UI → Event Bus: registers connector (evidence: `UmiOCR-data/py_src/run.py`)
- Desktop UI → Keyboard Hooks: registers connector (evidence: `UmiOCR-data/py_src/run.py`)
- Desktop UI → Global Settings: loads configuration (evidence: `UmiOCR-data/py_src/run.py`)
