How hiroi-sora/umi-ocr works
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: run.py Desktop UI · mission_ocr.py Image OCR Tasks · mission_doc.py Document Tasks · BatchDOC.py Document Tab
Components 24
UI and Capture
- Desktop UI
UmiOCR-data/py_src/run.py - Feature Tabs
UmiOCR-data/py_src/tag_pages/tag_pages_connector.py - Screenshot Capture
UmiOCR-data/py_src/image_controller/screenshot_controller.py - Image Provider
UmiOCR-data/py_src/image_controller/image_provider.py - Batch OCR Tab
UmiOCR-data/py_src/tag_pages/BatchOCR.py - Document Tab
UmiOCR-data/py_src/tag_pages/BatchDOC.py - Screenshot Tab
UmiOCR-data/py_src/tag_pages/ScreenshotOCR.py
Task Processing
- Mission Scheduler
UmiOCR-data/py_src/mission/mission.py - Image OCR Tasks
UmiOCR-data/py_src/mission/mission_ocr.py - Document Tasks
UmiOCR-data/py_src/mission/mission_doc.py - Document Preview
UmiOCR-data/py_src/mission/doc_preview_connector.py - QR Tools
UmiOCR-data/py_src/tag_pages/QRCode.py
OCR and Export
- Layout Parsers
UmiOCR-data/py_src/ocr/tbpu/parser_tools/paragraph_parse.py - Line Parsing
UmiOCR-data/py_src/ocr/tbpu/parser_single_line.py - OCR API
UmiOCR-data/py_src/ocr/api/__init__.py - Result Export
UmiOCR-data/py_src/ocr/output
External Interfaces
- Command Client
UmiOCR-data/py_src/server/cmd_client.py - HTTP Services
UmiOCR-data/py_src/server/ocr_server.py
Runtime and Settings
- OCR Plugins
UmiOCR-data/py_src/plugins_controller/plugins_controller.py - Event Bus
UmiOCR-data/py_src/event_bus/pubsub_service.py - Keyboard Hooks
UmiOCR-data/py_src/event_bus/key_mouse/keyboard.py - Global Settings
UmiOCR-data/py_src/utils/pre_configs.py - Application Entry
UmiOCR-data/main.py
Other components
- User
Connections 28
- User → Desktop UI: uses
- Desktop UI → Feature Tabs: registers tabs
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
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
UmiOCR-data/py_src/tag_pages/BatchDOC.py - Document Preview → Document Tasks: requests OCR
UmiOCR-data/py_src/mission/doc_preview_connector.py - Document Tasks → Mission Scheduler: extends
UmiOCR-data/py_src/mission/mission_doc.py - Image OCR Tasks → Mission Scheduler: extends
UmiOCR-data/py_src/mission/mission_ocr.py - Image OCR Tasks → OCR API: calls engine
UmiOCR-data/py_src/mission/mission_ocr.py - Document Tasks → Image OCR Tasks: recognizes pages
UmiOCR-data/py_src/mission/mission_doc.py - Image OCR Tasks → Layout Parsers: parses results
- Document Tasks → Layout Parsers: parses results
UmiOCR-data/py_src/mission/mission_doc.py - Line Parsing → Layout Parsers: uses paragraph rules
UmiOCR-data/py_src/ocr/tbpu/parser_single_line.py - Image OCR Tasks → Result Export: writes results
- Document Tab → Result Export: exports documents
UmiOCR-data/py_src/tag_pages/BatchDOC.py - OCR Plugins → OCR API: initializes plugins
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
UmiOCR-data/main.py - Desktop UI → Event Bus: registers connector
UmiOCR-data/py_src/run.py - Desktop UI → Keyboard Hooks: registers connector
UmiOCR-data/py_src/run.py - Desktop UI → Global Settings: loads configuration
UmiOCR-data/py_src/run.py