# thedtvn/mbbank architecture

> Architecture diagram of the GitHub repository thedtvn/mbbank, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/thedtvn/mbbank
- Repository: https://github.com/thedtvn/mbbank

## Overview

##### Project type and purpose
- This is an open-source Python client library (“SDK”) for interacting with Military Commercial Joint Stock Bank’s personal-account API. It wraps HTTP calls to the bank, handles CAPTCHA via OCR (either ONNX or a WASM fallback), and exposes both synchronous and asynchronous interfaces.

##### File structure
Top level:
- .github/ – CI/CD workflows (linting, tests, publishing)
- docs/ & mkdocs.yml – documentation source and site config
- setup.py, req.txt, .readthedocs.yaml – packaging, dependencies, docs build
- mbbank/ – core library modules
– main.py: entry point and sync client
– mbasync.py: async client variants
– capcha_ocr.py: orchestration for image→text via OCR
– wasm_helper/: fallback OCR helper in WASM
- tests/: sync_test.py, async_test.py

##### README for additional insights
- Purpose: avoid paid 3rd-party API costs
- Optional GPU-accelerated OCR (onnxruntime + CUDA)
- Python 3 only

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Interface Layer
    subgraph "SDK Interface Layer"
        SyncClient["SyncClient"]:::sdk
        AsyncClient["AsyncClient"]:::sdk
    end

    %% Transport Layer
    subgraph "Request/Response Layer"
        HTTPBuilder["HTTP Request Builder & Response Parser"]:::sdk
    end

    %% OCR Engine Layer
    subgraph "OCR Engine Layer"
        OCROrch["OCR Orchestrator"]:::sdk
        ONNX["ONNX Runtime (Optional GPU)"]:::external
        subgraph "WASM Helper Module"
            WASMInit["__init__.py"]:::sdk
            WASMHelper["helper.py"]:::sdk
        end
    end

    %% External Systems
    subgraph "External Services"
        BankAPI[(MBBank API)]:::external
        WasmRuntime[(WASM Runtime)]:::external
    end

    %% Support Modules
    subgraph "Support & CI/CD"
        TestsSync["Sync Client Tests"]:::support
        TestsAsync["Async Client Tests"]:::support
        CI["CI/CD Workflows"]:::support
        Docs["Documentation Source"]:::support
    end

    %% User Code Entry
    UserCode["User Code"]:::external

    %% Data Flows
    UserCode --> SyncClient
    UserCode --> AsyncClient

    SyncClient --> HTTPBuilder
    AsyncClient --> HTTPBuilder

    HTTPBuilder --> BankAPI
    BankAPI --> HTTPBuilder

    HTTPBuilder --> OCROrch
    OCROrch --> ONNX
    OCROrch --> WASMHelper
    ONNX -->|"if available"| OCROrch
    WasmRuntime -->|"fallback runtime"| WASMHelper
    WASMHelper --> OCROrch
    OCROrch --> HTTPBuilder

    HTTPBuilder --> SyncClient
    HTTPBuilder --> AsyncClient
    SyncClient --> UserCode
    AsyncClient --> UserCode

    %% Support Connections
    SyncClient --- TestsSync
    AsyncClient --- TestsAsync
    CI --- TestsSync
    CI --- TestsAsync
    CI --- Docs

    %% Click Events
    click SyncClient "https://github.com/thedtvn/mbbank/blob/main/mbbank/main.py"
    click AsyncClient "https://github.com/thedtvn/mbbank/blob/main/mbbank/mbasync.py"
    click HTTPBuilder "https://github.com/thedtvn/mbbank/blob/main/mbbank/main.py"
    click OCROrch "https://github.com/thedtvn/mbbank/blob/main/mbbank/capcha_ocr.py"
    click WASMHelper "https://github.com/thedtvn/mbbank/blob/main/mbbank/wasm_helper/helper.py"
    click WASMInit "https://github.com/thedtvn/mbbank/blob/main/mbbank/wasm_helper/__init__.py"
    click TestsSync "https://github.com/thedtvn/mbbank/blob/main/tests/sync_test.py"
    click TestsAsync "https://github.com/thedtvn/mbbank/blob/main/tests/async_test.py"
    click CI "https://github.com/thedtvn/mbbank/blob/main/.github/workflows/python-publish.yml"
    click Docs "https://github.com/thedtvn/mbbank/tree/main/docs/"

    %% Styles
    classDef sdk fill:#CFE2F3,stroke:#0B5394,color:#0B5394;
    classDef external fill:#D9EAD3,stroke:#38761D,color:#38761D;
    classDef support fill:#F2F2F2,stroke:#7F7F7F,color:#7F7F7F;
```
