# koljutsii/appeick architecture

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

- Interactive diagram: https://gitdiagram.com/koljutsii/appeick
- Repository: https://github.com/koljutsii/appeick

## Overview

This is a PySide6 desktop application whose main substantive workflow is entering business/document details alongside a PDF or image, navigating its pages, and preparing text blocks for document work. The main window opens four tabs and preferences; Tab 2 contains the detailed form and document controls, while document handlers provide PDF/image loading and OCR-related operations. Shared modules supply settings, text processing, and Qt widget wrappers. Several tabs are visibly placeholders. The README is empty, so capability and relationship evidence is limited to the sampled source and SOURCE INDEX; OCR details beyond the shown document methods are not expanded.

Main entry points: [`mainQt.py`](https://github.com/koljutsii/appeick/blob/master/mainQt.py) (Main window), [`data_handler.py`](https://github.com/koljutsii/appeick/blob/master/data_handler.py) (Settings and app data), [`tab_2.py`](https://github.com/koljutsii/appeick/blob/master/tab_2.py) (Document tab), [`interfaces/widget_constructor.py`](https://github.com/koljutsii/appeick/blob/master/interfaces/widget_constructor.py) (Qt widget wrappers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_application["Application UI"]
  node_main["Main window<br/>[mainQt.py]"]
  node_tab1["Tab 1<br/>[tab_1.py]"]
  node_tab3["Tab 3<br/>[tab_3.py]"]
  node_tab4["Tab 4<br/>[tab_4.py]"]
  node_preferences["Preferences dialog<br/>[dialog.py]"]
  node_ui1["Tab 1 layout<br/>[UI_tab1.py]"]
end

subgraph group_document["Document workflow"]
  node_tab2["Document tab<br/>[tab_2.py]"]
  node_ui2["Document form layout<br/>[UI_tab2.py]"]
  node_document_handler["PDF and image handlers<br/>[document.py]"]
  node_text["Text cleanup and splitting<br/>[text_functions.py]"]
end

subgraph group_shared["Shared services"]
  node_widgets["Qt widget wrappers"]
  node_data["Settings and app data<br/>[data_handler.py]"]
end

node_user(("User"))

node_user -->|"uses"| node_main
node_main -->|"creates"| node_tab1
node_main -->|"creates"| node_tab2
node_main -->|"creates"| node_tab3
node_main -->|"creates"| node_tab4
node_main -->|"opens"| node_preferences
node_tab1 -->|"creates"| node_ui1
node_tab2 -->|"creates"| node_ui2
node_user -->|"operates"| node_tab2
node_tab2 -->|"navigates pages"| node_document_handler
node_document_handler -->|"uses"| node_text
node_main -->|"reads settings"| node_data
node_tab1 -->|"gets app data"| node_data
node_tab2 -->|"gets app data"| node_data
node_tab3 -->|"gets app data"| node_data
node_tab4 -->|"gets app data"| node_data
node_preferences -->|"reads settings"| node_data
node_ui1 -->|"uses wrappers"| node_widgets
node_ui2 -->|"uses wrappers"| node_widgets
node_preferences -->|"uses wrappers"| node_widgets
node_document_handler -->|"gets app data"| node_data
node_tab2 -->|"uses wrappers"| node_widgets

click node_main "https://github.com/koljutsii/appeick/blob/master/mainQt.py"
click node_tab1 "https://github.com/koljutsii/appeick/blob/master/tab_1.py"
click node_tab2 "https://github.com/koljutsii/appeick/blob/master/tab_2.py"
click node_tab3 "https://github.com/koljutsii/appeick/blob/master/tab_3.py"
click node_tab4 "https://github.com/koljutsii/appeick/blob/master/tab_4.py"
click node_preferences "https://github.com/koljutsii/appeick/blob/master/dialog.py"
click node_ui1 "https://github.com/koljutsii/appeick/blob/master/interfaces/UI_tab1.py"
click node_ui2 "https://github.com/koljutsii/appeick/blob/master/interfaces/UI_tab2.py"
click node_widgets "https://github.com/koljutsii/appeick/blob/master/interfaces/widget_constructor.py"
click node_document_handler "https://github.com/koljutsii/appeick/blob/master/document.py"
click node_text "https://github.com/koljutsii/appeick/blob/master/text_functions.py"
click node_data "https://github.com/koljutsii/appeick/blob/master/data_handler.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_main,node_tab1,node_tab3,node_tab4,node_preferences,node_ui1,node_user toneBlue
class node_tab2,node_ui2,node_document_handler,node_text toneAmber
class node_widgets,node_data toneMint
```

## Components

### Application UI

- [Main window](https://github.com/koljutsii/appeick/blob/master/mainQt.py): `mainQt.py`
- [Tab 1](https://github.com/koljutsii/appeick/blob/master/tab_1.py): `tab_1.py`
- [Tab 3](https://github.com/koljutsii/appeick/blob/master/tab_3.py): `tab_3.py`
- [Tab 4](https://github.com/koljutsii/appeick/blob/master/tab_4.py): `tab_4.py`
- [Preferences dialog](https://github.com/koljutsii/appeick/blob/master/dialog.py): `dialog.py`
- [Tab 1 layout](https://github.com/koljutsii/appeick/blob/master/interfaces/UI_tab1.py): `interfaces/UI_tab1.py`

### Document workflow

- [Document tab](https://github.com/koljutsii/appeick/blob/master/tab_2.py): `tab_2.py`
- [Document form layout](https://github.com/koljutsii/appeick/blob/master/interfaces/UI_tab2.py): `interfaces/UI_tab2.py`
- [PDF and image handlers](https://github.com/koljutsii/appeick/blob/master/document.py): `document.py`
- [Text cleanup and splitting](https://github.com/koljutsii/appeick/blob/master/text_functions.py): `text_functions.py`

### Shared services

- [Qt widget wrappers](https://github.com/koljutsii/appeick/blob/master/interfaces/widget_constructor.py): `interfaces/widget_constructor.py`
- [Settings and app data](https://github.com/koljutsii/appeick/blob/master/data_handler.py): `data_handler.py`

### Other components

- **User**

## Connections

- User → Main window: uses (evidence: `mainQt.py`)
- Main window → Tab 1: creates (evidence: `mainQt.py`)
- Main window → Document tab: creates (evidence: `mainQt.py`)
- Main window → Tab 3: creates (evidence: `mainQt.py`)
- Main window → Tab 4: creates (evidence: `mainQt.py`)
- Main window → Preferences dialog: opens (evidence: `mainQt.py`)
- Tab 1 → Tab 1 layout: creates (evidence: `tab_1.py`)
- Document tab → Document form layout: creates (evidence: `tab_2.py`)
- User → Document tab: operates
- Document tab → PDF and image handlers: navigates pages (evidence: `tab_2.py`)
- PDF and image handlers → Text cleanup and splitting: uses (evidence: `document.py`)
- Main window → Settings and app data: reads settings (evidence: `mainQt.py`)
- Tab 1 → Settings and app data: gets app data (evidence: `tab_1.py`)
- Document tab → Settings and app data: gets app data (evidence: `tab_2.py`)
- Tab 3 → Settings and app data: gets app data (evidence: `tab_3.py`)
- Tab 4 → Settings and app data: gets app data (evidence: `tab_4.py`)
- Preferences dialog → Settings and app data: reads settings (evidence: `dialog.py`)
- Tab 1 layout → Qt widget wrappers: uses wrappers (evidence: `interfaces/UI_tab1.py`)
- Document form layout → Qt widget wrappers: uses wrappers (evidence: `interfaces/UI_tab2.py`)
- Preferences dialog → Qt widget wrappers: uses wrappers (evidence: `dialog.py`)
- PDF and image handlers → Settings and app data: gets app data (evidence: `document.py`)
- Document tab → Qt widget wrappers: uses wrappers (evidence: `tab_2.py`)
