# openstack-kr/knu_i18n_2025 architecture

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

- Interactive diagram: https://gitdiagram.com/openstack-kr/knu_i18n_2025
- Repository: https://github.com/openstack-kr/knu_i18n_2025

## Overview

##### Project type and purpose
- This is a CLI-based internationalization (i18n) pipeline/toolset written in Python and Bash.
- Its goal is to generate and validate translated “.po” files from template “.pot” files, apply glossary rules, and ensure quality via automated checks (PEP8, ansible, custom validators).

##### File structure
- Top-level scripts and orchestration:
- main.sh       – entry point that sequences the pipeline.
- translate.py  – core translation logic (reads templates, applies glossary, writes .po).
- utils.py      – shared helper functions (file I/O, formatting).
- requirements.txt, tox.ini – dependency and code-quality tooling.
- Data directories:
- glossary/     – JSON and PO glossary entries for term consistency.
- pot/          – master “.pot” templates (e.g., releasenotes_swift.pot, sample.pot).
- po/           – generated and sample translation directories (organized by model and locale).
- Validation:
- validate/     – custom translation validators (check.py) plus sample .po files and bad_translations.txt as test cases.
- Configuration:
- experiments.json – optional config for experimental settings.
- Build & QA:
- tox integration for PEP8 and ansible playbook checks.

##### README for additional insights
- High-level usage: pip install, then bash main.sh.
- Quality gates: `tox -e pep8` and `tox -e ansible`.

##### Detail level
- Sub-components where relevant (e.g., utils.py under Translation Engine)
- Call out configuration points (requirements.txt, experiments.json)
- Parallel flows if multiple locales or models are processed concurrently

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Scripts and Modules
    subgraph "Scripts & Modules"
        Orchestrator["main.sh"]:::code
        TranslationEngine["translate.py"]:::code
        Utils["utils.py"]:::code
        ValidateScript["validate/check.py"]:::code
    end

    %% Data Repositories
    subgraph "Data Repositories"
        GlossaryStore(("Glossary Store")):::data
        TemplateStore(("Template Store")):::data
        OutputStore(("Output Store")):::data
    end

    %% Validation Samples
    subgraph "Validation Samples"
        BadTranslations["bad_translations.txt"]:::data
        Sample_CN["sample_CN.po"]:::data
        Sample_ja["sample_ja.po"]:::data
        Sample_ru["sample_ru.po"]:::data
        Sample_answer["sample_answer.po"]:::data
    end

    %% Configuration & QA
    subgraph "Config & QA Tools"
        Tox["tox.ini"]:::code
        Requirements["requirements.txt"]:::code
        Experiments["experiments.json"]:::code
    end

    %% External Dependencies
    subgraph "External Services"
        ExternalAPI(("External Translation API")):::external
    end

    %% Flow Connections
    Orchestrator -->|"invoke"| TranslationEngine
    TranslationEngine -->|"use utils"| Utils
    TranslationEngine -->|"read JSON/PO"| GlossaryStore
    TranslationEngine -->|"read .pot files"| TemplateStore
    TranslationEngine -->|"write .po files"| OutputStore
    TranslationEngine -->|"call API"| ExternalAPI

    Orchestrator -->|"invoke"| ValidateScript
    ValidateScript -->|"scan .po files"| OutputStore
    ValidateScript -->|"use list"| BadTranslations
    ValidateScript -->|"compare samples"| Sample_CN
    ValidateScript -->|"compare samples"| Sample_ja
    ValidateScript -->|"compare samples"| Sample_ru
    ValidateScript -->|"compare samples"| Sample_answer

    Orchestrator -->|"trigger QA"| Tox
    Tox -->|"deps"| Requirements
    Experiments -.->|"optional config"| TranslationEngine

    %% Click Events
    click Orchestrator "https://github.com/openstack-kr/knu_i18n_2025/blob/main/main.sh"
    click TranslationEngine "https://github.com/openstack-kr/knu_i18n_2025/blob/main/translate.py"
    click Utils "https://github.com/openstack-kr/knu_i18n_2025/blob/main/utils.py"
    click GlossaryStore "https://github.com/openstack-kr/knu_i18n_2025/tree/main/glossary/"
    click TemplateStore "https://github.com/openstack-kr/knu_i18n_2025/tree/main/pot/"
    click OutputStore "https://github.com/openstack-kr/knu_i18n_2025/tree/main/po/"
    click ValidateScript "https://github.com/openstack-kr/knu_i18n_2025/blob/main/validate/check.py"
    click BadTranslations "https://github.com/openstack-kr/knu_i18n_2025/blob/main/validate/bad_translations.txt"
    click Sample_CN "https://github.com/openstack-kr/knu_i18n_2025/blob/main/validate/sample_CN.po"
    click Sample_ja "https://github.com/openstack-kr/knu_i18n_2025/blob/main/validate/sample_ja.po"
    click Sample_ru "https://github.com/openstack-kr/knu_i18n_2025/blob/main/validate/sample_ru.po"
    click Sample_answer "https://github.com/openstack-kr/knu_i18n_2025/blob/main/validate/sample_answer.po"
    click Tox "https://github.com/openstack-kr/knu_i18n_2025/blob/main/tox.ini"
    click Requirements "https://github.com/openstack-kr/knu_i18n_2025/blob/main/requirements.txt"
    click Experiments "https://github.com/openstack-kr/knu_i18n_2025/blob/main/experiments.json"

    %% Styles
    classDef code fill:#cce5ff,stroke:#000,stroke-width:1px
    classDef data fill:#d4edda,stroke:#000,stroke-width:1px
    classDef external fill:#fff3cd,stroke:#000,stroke-width:1px
```
