# kathirkarky/tamilenkal architecture

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

- Interactive diagram: https://gitdiagram.com/kathirkarky/tamilenkal
- Repository: https://github.com/kathirkarky/tamilenkal

## Overview

##### What this project is (type + purpose)
From the file tree + README, this is a **Python library/package** (not a service) intended to perform **Tamil numeral conversions and basic numeric operations**.

- **Primary purpose:** Convert between **Arabic numerals (int/float)** and **Tamil numerals (string representation)** and provide arithmetic/rounding helpers that *return results in Tamil numerals*.
- **Packaging/distribution:** `setup.py` indicates it’s built and distributed as a Python package (likely to PyPI).
- **CI/CD:** `.github/workflows/python-publish.yml` indicates an automated publish pipeline.
- **Usage example surface:** `TamilEnkalDemo.ipynb` is a consumer/demo artifact.

Top-level:
- `TamilEnmam/` → the **actual Python package**
- `TamilEnmam/TamilEnkal.py` → the **core implementation module**
- `TamilEnmam/__init__.py` → package exports / public API surface
- `setup.py` → packaging metadata, install entry point
- `.github/workflows/python-publish.yml` → publishing automation
- `TamilEnkalDemo.ipynb` → example consumer
- `README.md`, `LICENSE` → documentation/legal

Architecturally, this splits naturally into **(A) runtime library components** and **(B) build/release components**.

##### External actor / consumer
- **Python user code** (any app/script/notebook)
- **Jupyter Notebook** (explicitly represented by `TamilEnkalDemo.ipynb`)

##### Public API layer (package boundary)
- **TamilEnmam package** (`TamilEnmam/__init__.py`)
- Treat this as the **public façade**: what users import.
- If `__init__.py` re-exports functions from `TamilEnkal.py`, show that explicitly.

##### Core module
- **TamilEnkal module** (`TamilEnmam/TamilEnkal.py`)
- This contains the functions listed in the README and likely internal helpers/constants.

##### Conversion: Arabic → Tamil
- `TamilEn(arabic_number) -> tamil_string`

##### Conversion: Tamil → Arabic
- `ArabuEn(tamil_string) -> arabic_number`

##### Rounding layer
- `TamilSutru(arabic_number) -> tamil_string` (round then convert)
- `ArabuSutru(tamil_string) -> arabic_number` (parse then round)

##### Arithmetic operations (compute in Arabic, return Tamil)
- `Perumam(a,b)` max
- `Sirumam(a,b)` min
- `Koottal(a,b)` add
- `Kazhithal(a,b)` subtract
- `Perukkal(a,b)` multiply
- `Eevu(a,b)` quotient/division
- `Meedhi(a,b)` remainder/mod

- Tamil digit/symbol mapping tables (e.g., Tamil digits 0–9, tens, hundreds, etc.)
- Normalization/validation (strip spaces, validate characters)
- Tokenization/parsing logic (Tamil numeral string → numeric)
- Formatting logic (numeric → Tamil numeral string)

##### Flow 1: Arabic → Tamil conversion
`Consumer (int/float)` → calls `TamilEnmam.TamilEn()` → uses **mapping/formatting** → returns `Tamil string`

##### Flow 2: Tamil → Arabic conversion
`Consumer (Tamil string)` → calls `TamilEnmam.ArabuEn()` → uses **parsing/tokenization + mapping** → returns `int/float`

##### Flow 3: Arithmetic helpers
`Consumer (a,b)` → calls `Koottal/Perukkal/etc.`
These likely do:
- compute using Python numeric ops (`a+b`, `a*b`, etc.)
- then call `TamilEn(result)`
`Koottal()` → `TamilEn()` (dependency)
Same for `Kazhithal`, `Perukkal`, `Eevu`, `Meedhi`, `Perumam`, `Sirumam`.

##### Flow 4: Rounding helpers
- `TamilSutru(x)` → `round(x)` / rounding logic → `TamilEn(rounded)`
- `ArabuSutru(t)` → `ArabuEn(t)` → `round(result)` (or rounding logic)

These dependencies matter: it shows there’s a “core conversion primitive” reused by higher-level utilities.

##### Components
- **Developer** pushes tags/commits to GitHub
- **GitHub Actions workflow** (`.github/workflows/python-publish.yml`)
- **Build step** (sdist/wheel via setuptools)
- **Package index** (PyPI or equivalent target)
- **End user installation** (`pip install ...`) pulling from PyPI

##### Relationships
`GitHub repo` → triggers `GitHub Actions` → builds artifacts → publishes to `Package Registry` → user installs → imports `TamilEnmam`

This is part of “system architecture” for a library project: the distribution path is a core system concern.

- User / consumer code
- TamilEnkal library
- PyPI (distribution), GitHub Actions (delivery)

- “Consumer environment” (Notebook/App)
- “TamilEnmam package (in-process)”
- “Python runtime”
- (Optional) “PyPI” as external dependency only for installation time

- Inside the package: `__init__.py` API façade, `TamilEnkal.py` module
- Inside the module: Conversion, Parsing, Formatting, Rounding, Arithmetic
- Function-level dependencies (especially arithmetic → TamilEn)

## Diagram (Mermaid)

```mermaid
flowchart TD

%% =========================
%% Diagram A — Runtime usage
%% =========================

subgraph "Runtime (in-process library usage)"
direction TB

subgraph "Consumers"
direction TB
UserCode["Python user code\n(app/script)"]:::consumer
Notebook["TamilEnkalDemo.ipynb\n(Jupyter demo consumer)"]:::consumer
end

subgraph "TamilEnmam Python package (library boundary)"
direction TB
Pkg["TamilEnmam\n(Python package)"]:::package
Facade["__init__.py\n(Public API facade)"]:::api

subgraph "TamilEnkal.py (core implementation module)"
direction TB
Core["TamilEnkal.py\n(Implementation module)"]:::module

subgraph "Logical components inside TamilEnkal.py"
direction TB

subgraph "Conversion primitives"
direction TB
TamilEn["TamilEn(arabic_number)\nArabic → Tamil"]:::func
ArabuEn["ArabuEn(tamil_string)\nTamil → Arabic"]:::func
end

subgraph "Rounding utilities"
direction TB
TamilSutru["TamilSutru(arabic_number)\nround → Tamil"]:::util
ArabuSutru["ArabuSutru(tamil_string)\nparse → round"]:::util
end

subgraph "Arithmetic utilities\n(compute in Arabic → return Tamil)"
direction TB
Perumam["Perumam(a,b)\nmax → Tamil"]:::util
Sirumam["Sirumam(a,b)\nmin → Tamil"]:::util
Koottal["Koottal(a,b)\nadd → Tamil"]:::util
Kazhithal["Kazhithal(a,b)\nsubtract → Tamil"]:::util
Perukkal["Perukkal(a,b)\nmultiply → Tamil"]:::util
Eevu["Eevu(a,b)\ndivide → Tamil"]:::util
Meedhi["Meedhi(a,b)\nmod → Tamil"]:::util
end

Helpers["Internal helpers\n(mapping tables, validation,\nparsing/tokenization, formatting rules)"]:::internal
end
end
end

%% --- Runtime call flows ---
UserCode -->|"imports"| Facade
Notebook -->|"imports"| Facade
Facade -->|"re-exports / delegates"| Core

%% Public API calls (typed data)
UserCode -->|"int/float→Tamil string"| TamilEn
UserCode -->|"Tamil string→int/float"| ArabuEn
UserCode -->|"int/float→Tamil string"| TamilSutru
UserCode -->|"Tamil string→int/float"| ArabuSutru
UserCode -->|"a,b→Tamil string"| Koottal
UserCode -->|"a,b→Tamil string"| Kazhithal
UserCode -->|"a,b→Tamil string"| Perukkal
UserCode -->|"a,b→Tamil string"| Eevu
UserCode -->|"a,b→Tamil string"| Meedhi
UserCode -->|"a,b→Tamil string"| Perumam
UserCode -->|"a,b→Tamil string"| Sirumam

Notebook -->|"int/float→Tamil string"| TamilEn
Notebook -->|"Tamil string→int/float"| ArabuEn

%% Dependencies inside module
TamilEn -->|"uses"| Helpers
ArabuEn -->|"uses"| Helpers

TamilSutru -->|"rounds_then_calls"| TamilEn
ArabuSutru -->|"calls"| ArabuEn

Koottal -->|"calls"| TamilEn
Kazhithal -->|"calls"| TamilEn
Perukkal -->|"calls"| TamilEn
Eevu -->|"calls"| TamilEn
Meedhi -->|"calls"| TamilEn
Perumam -->|"calls"| TamilEn
Sirumam -->|"calls"| TamilEn

%% Membership hints
Pkg -->|"contains"| Facade
Pkg -->|"contains"| Core
Core -->|"implements"| TamilEn
Core -->|"implements"| ArabuEn
Core -->|"implements"| TamilSutru
Core -->|"implements"| ArabuSutru
Core -->|"implements"| Koottal
Core -->|"implements"| Kazhithal
Core -->|"implements"| Perukkal
Core -->|"implements"| Eevu
Core -->|"implements"| Meedhi
Core -->|"implements"| Perumam
Core -->|"implements"| Sirumam
Core -->|"implements"| Helpers

end

%% =================================
%% Diagram B — Build/Release pipeline
%% =================================

subgraph "Distribution / Release (install-time)"
direction TB

Dev["Developer"]:::actor
Repo["GitHub repository"]:::external
Docs["README.md\nDocumentation"]:::doc
Lic["LICENSE\nLegal"]:::doc

GA["GitHub Actions\npython-publish workflow"]:::cicd
Workflow["python-publish.yml"]:::cicdfile

Build["Build artifacts\n(sdist / wheel)"]:::artifact
Setup["setup.py\n(setuptools metadata)"]:::build
Registry["Package registry\n(PyPI)"]:::external
Pip["pip install TamilEnmam"]:::consumer

Dev -->|"push / tag"| Repo
Repo -->|"hosts"| Docs
Repo -->|"hosts"| Lic
Repo -->|"triggers_on_release"| GA
GA -->|"uses"| Workflow
GA -->|"builds_via_setuptools"| Setup
GA -->|"produces"| Build
GA -->|"publishes"| Registry
Pip -->|"downloads"| Registry
Pip -->|"installs"| Pkg

end

%% =========================
%% Click events (mapped paths)
%% =========================
click Pkg "https://github.com/kathirkarky/tamilenkal/tree/main/TamilEnmam/"
click Facade "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/__init__.py"
click Core "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click TamilEn "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click ArabuEn "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click TamilSutru "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click ArabuSutru "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Koottal "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Kazhithal "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Perukkal "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Eevu "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Meedhi "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Perumam "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Sirumam "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Helpers "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnmam/TamilEnkal.py"
click Setup "https://github.com/kathirkarky/tamilenkal/blob/main/setup.py"
click Workflow "https://github.com/kathirkarky/tamilenkal/blob/main/.github/workflows/python-publish.yml"
click Notebook "https://github.com/kathirkarky/tamilenkal/blob/main/TamilEnkalDemo.ipynb"
click Docs "https://github.com/kathirkarky/tamilenkal/blob/main/README.md"
click Lic "https://github.com/kathirkarky/tamilenkal/tree/main/LICENSE"

%% =========================
%% Styles
%% =========================
classDef consumer fill:#D6F5D6,stroke:#2E7D32,stroke-width:1.5px,color:#0B3D0B
classDef package fill:#DCEBFF,stroke:#1E5AA8,stroke-width:1.8px,color:#0B2B52
classDef api fill:#CFE8FF,stroke:#1565C0,stroke-width:1.5px,color:#0B2B52
classDef module fill:#BFD7FF,stroke:#0D47A1,stroke-width:1.8px,color:#082544
classDef func fill:#E6F0FF,stroke:#2A5DB0,stroke-width:1.2px,color:#082544
classDef util fill:#EEF5FF,stroke:#2A5DB0,stroke-width:1.2px,color:#082544
classDef internal fill:#F2E8FF,stroke:#6A1B9A,stroke-width:1.3px,color:#2E0B45
classDef cicd fill:#FFE0B2,stroke:#EF6C00,stroke-width:1.6px,color:#4A2500
classDef cicdfile fill:#FFD6A6,stroke:#EF6C00,stroke-width:1.2px,color:#4A2500
classDef build fill:#FFF3CD,stroke:#B28704,stroke-width:1.4px,color:#4A3B00
classDef artifact fill:#FFECB3,stroke:#B28704,stroke-width:1.4px,color:#4A3B00
classDef external fill:#F5F5F5,stroke:#616161,stroke-width:1.4px,color:#212121
classDef actor fill:#E1F5FE,stroke:#0277BD,stroke-width:1.4px,color:#01324F
classDef doc fill:#FFF7E6,stroke:#A66A00,stroke-width:1.2px,color:#4A2D00
```
