# linahoubing/classdiagram-toolkit architecture

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

- Interactive diagram: https://gitdiagram.com/linahoubing/classdiagram-toolkit
- Repository: https://github.com/linahoubing/classdiagram-toolkit

## Overview

ClassDiagram Toolkit converts Mermaid and PlantUML class diagrams through a shared intermediate representation, and scans Python source with the AST to produce diagrams. Users can run either workflow through the CLI or call the library API; outputs include Mermaid, PlantUML, and Graphviz DOT. The relationships shown are supported by the README or sampled source; the AST scanner excerpt is partial, so its internal parsing steps are not expanded.

Main entry points: [`src/classdiagram_toolkit/cli.py`](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/cli.py) (CLI), [`src/classdiagram_toolkit/converter.py`](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/converter.py) (Conversion coordinator), [`src/classdiagram_toolkit/ir.py`](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/ir.py) (Diagram IR), [`src/classdiagram_toolkit/__init__.py`](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/__init__.py) (Library API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User interfaces"]
  node_cli["CLI<br/>[cli.py]"]
  node_library["Library API<br/>[__init__.py]"]
  node_module_entry["Module entry<br/>[__main__.py]"]
end

subgraph group_model["Diagram modeling"]
  node_ir["Diagram IR<br/>[ir.py]"]
  node_scanner["Python AST scanner<br/>[scan.py]"]
end

subgraph group_formats["Parsing and generation"]
  node_converter["Conversion coordinator<br/>[converter.py]"]
  node_mermaid_parser["Mermaid parser<br/>[parsers.py]"]
  node_plantuml_parser["PlantUML parser<br/>[parsers.py]"]
  node_mermaid_generator["Mermaid generator<br/>[generators.py]"]
  node_plantuml_generator["PlantUML generator<br/>[generators.py]"]
  node_dot_generator["DOT generator<br/>[generators.py]"]
end

node_user(("Developer"))
node_input_files["Diagram or source"]
node_outputs["Output destination"]

node_user -->|"invokes"| node_cli
node_user -->|"calls"| node_library
node_input_files -->|"provides input"| node_cli
node_cli -->|"converts diagrams"| node_converter
node_cli -->|"scans source"| node_scanner
node_cli -->|"selects generator"| node_mermaid_generator
node_cli -->|"selects generator"| node_plantuml_generator
node_cli -->|"selects generator"| node_dot_generator
node_cli -->|"writes diagram"| node_outputs
node_module_entry -->|"runs"| node_cli
node_library -->|"exports conversion"| node_converter
node_library -->|"exports scanning"| node_scanner
node_converter -->|"parses Mermaid"| node_mermaid_parser
node_converter -->|"parses PlantUML"| node_plantuml_parser
node_converter -->|"uses diagram model"| node_ir
node_converter -->|"generates output"| node_mermaid_generator
node_converter -->|"generates output"| node_plantuml_generator
node_converter -->|"generates output"| node_dot_generator
node_mermaid_parser -->|"builds diagram"| node_ir
node_plantuml_parser -->|"builds diagram"| node_ir
node_scanner -->|"builds diagram"| node_ir
node_mermaid_generator -->|"renders diagram"| node_ir
node_plantuml_generator -->|"renders diagram"| node_ir
node_dot_generator -->|"renders diagram"| node_ir

click node_cli "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/cli.py"
click node_library "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/__init__.py"
click node_module_entry "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/__main__.py"
click node_ir "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/ir.py"
click node_scanner "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/scan.py"
click node_converter "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/converter.py"
click node_mermaid_parser "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/parsers.py"
click node_plantuml_parser "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/parsers.py"
click node_mermaid_generator "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/generators.py"
click node_plantuml_generator "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/generators.py"
click node_dot_generator "https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/generators.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_cli,node_library,node_module_entry toneBlue
class node_ir,node_scanner toneAmber
class node_converter,node_mermaid_parser,node_plantuml_parser,node_mermaid_generator,node_plantuml_generator,node_dot_generator toneMint
class node_user,node_input_files,node_outputs toneIndigo
```

## Components

### User interfaces

- [CLI](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/cli.py): `src/classdiagram_toolkit/cli.py`
- [Library API](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/__init__.py): `src/classdiagram_toolkit/__init__.py`
- [Module entry](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/__main__.py): `src/classdiagram_toolkit/__main__.py`

### Diagram modeling

- [Diagram IR](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/ir.py): `src/classdiagram_toolkit/ir.py`
- [Python AST scanner](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/scan.py): `src/classdiagram_toolkit/scan.py`

### Parsing and generation

- [Conversion coordinator](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/converter.py): `src/classdiagram_toolkit/converter.py`
- [Mermaid parser](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/parsers.py): `src/classdiagram_toolkit/parsers.py`
- [PlantUML parser](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/parsers.py): `src/classdiagram_toolkit/parsers.py`
- [Mermaid generator](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/generators.py): `src/classdiagram_toolkit/generators.py`
- [PlantUML generator](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/generators.py): `src/classdiagram_toolkit/generators.py`
- [DOT generator](https://github.com/linahoubing/classdiagram-toolkit/blob/main/src/classdiagram_toolkit/generators.py): `src/classdiagram_toolkit/generators.py`

### Other components

- **Developer**
- **Diagram or source**
- **Output destination**

## Connections

- Developer → CLI: invokes (evidence: `README.md`)
- Developer → Library API: calls (evidence: `README.md`)
- Diagram or source → CLI: provides input (evidence: `src/classdiagram_toolkit/cli.py`)
- CLI → Conversion coordinator: converts diagrams (evidence: `src/classdiagram_toolkit/cli.py`)
- CLI → Python AST scanner: scans source (evidence: `src/classdiagram_toolkit/cli.py`)
- CLI → Mermaid generator: selects generator (evidence: `src/classdiagram_toolkit/cli.py`)
- CLI → PlantUML generator: selects generator (evidence: `src/classdiagram_toolkit/cli.py`)
- CLI → DOT generator: selects generator (evidence: `src/classdiagram_toolkit/cli.py`)
- CLI → Output destination: writes diagram (evidence: `src/classdiagram_toolkit/cli.py`)
- Module entry → CLI: runs (evidence: `src/classdiagram_toolkit/__main__.py`)
- Library API → Conversion coordinator: exports conversion (evidence: `src/classdiagram_toolkit/__init__.py`)
- Library API → Python AST scanner: exports scanning (evidence: `src/classdiagram_toolkit/__init__.py`)
- Conversion coordinator → Mermaid parser: parses Mermaid (evidence: `src/classdiagram_toolkit/converter.py`)
- Conversion coordinator → PlantUML parser: parses PlantUML (evidence: `src/classdiagram_toolkit/converter.py`)
- Conversion coordinator → Diagram IR: uses diagram model (evidence: `src/classdiagram_toolkit/converter.py`)
- Conversion coordinator → Mermaid generator: generates output (evidence: `src/classdiagram_toolkit/converter.py`)
- Conversion coordinator → PlantUML generator: generates output (evidence: `src/classdiagram_toolkit/converter.py`)
- Conversion coordinator → DOT generator: generates output (evidence: `src/classdiagram_toolkit/converter.py`)
- Mermaid parser → Diagram IR: builds diagram (evidence: `src/classdiagram_toolkit/parsers.py`)
- PlantUML parser → Diagram IR: builds diagram (evidence: `src/classdiagram_toolkit/parsers.py`)
- Python AST scanner → Diagram IR: builds diagram (evidence: `src/classdiagram_toolkit/scan.py`)
- Mermaid generator → Diagram IR: renders diagram (evidence: `src/classdiagram_toolkit/generators.py`)
- PlantUML generator → Diagram IR: renders diagram (evidence: `src/classdiagram_toolkit/generators.py`)
- DOT generator → Diagram IR: renders diagram (evidence: `src/classdiagram_toolkit/generators.py`)
