How linahoubing/classdiagram-toolkit works
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: cli.py CLI · converter.py Conversion coordinator · ir.py Diagram IR · __init__.py Library API
Components 14
User interfaces
- CLI
src/classdiagram_toolkit/cli.py - Library API
src/classdiagram_toolkit/__init__.py - Module entry
src/classdiagram_toolkit/__main__.py
Diagram modeling
- Diagram IR
src/classdiagram_toolkit/ir.py - Python AST scanner
src/classdiagram_toolkit/scan.py
Parsing and generation
- Conversion coordinator
src/classdiagram_toolkit/converter.py - Mermaid parser
src/classdiagram_toolkit/parsers.py - PlantUML parser
src/classdiagram_toolkit/parsers.py - Mermaid generator
src/classdiagram_toolkit/generators.py - PlantUML generator
src/classdiagram_toolkit/generators.py - DOT generator
src/classdiagram_toolkit/generators.py
Other components
- Developer
- Diagram or source
- Output destination
Connections 24
- Developer → CLI: invokes
README.md - Developer → Library API: calls
README.md - Diagram or source → CLI: provides input
src/classdiagram_toolkit/cli.py - CLI → Conversion coordinator: converts diagrams
src/classdiagram_toolkit/cli.py - CLI → Python AST scanner: scans source
src/classdiagram_toolkit/cli.py - CLI → Mermaid generator: selects generator
src/classdiagram_toolkit/cli.py - CLI → PlantUML generator: selects generator
src/classdiagram_toolkit/cli.py - CLI → DOT generator: selects generator
src/classdiagram_toolkit/cli.py - CLI → Output destination: writes diagram
src/classdiagram_toolkit/cli.py - Module entry → CLI: runs
src/classdiagram_toolkit/__main__.py - Library API → Conversion coordinator: exports conversion
src/classdiagram_toolkit/__init__.py - Library API → Python AST scanner: exports scanning
src/classdiagram_toolkit/__init__.py - Conversion coordinator → Mermaid parser: parses Mermaid
src/classdiagram_toolkit/converter.py - Conversion coordinator → PlantUML parser: parses PlantUML
src/classdiagram_toolkit/converter.py - Conversion coordinator → Diagram IR: uses diagram model
src/classdiagram_toolkit/converter.py - Conversion coordinator → Mermaid generator: generates output
src/classdiagram_toolkit/converter.py - Conversion coordinator → PlantUML generator: generates output
src/classdiagram_toolkit/converter.py - Conversion coordinator → DOT generator: generates output
src/classdiagram_toolkit/converter.py - Mermaid parser → Diagram IR: builds diagram
src/classdiagram_toolkit/parsers.py - PlantUML parser → Diagram IR: builds diagram
src/classdiagram_toolkit/parsers.py - Python AST scanner → Diagram IR: builds diagram
src/classdiagram_toolkit/scan.py - Mermaid generator → Diagram IR: renders diagram
src/classdiagram_toolkit/generators.py - PlantUML generator → Diagram IR: renders diagram
src/classdiagram_toolkit/generators.py - DOT generator → Diagram IR: renders diagram
src/classdiagram_toolkit/generators.py