https://github.com/t0ine34/diagramtool
Python script for creating UML diagrams from source code.
https://github.com/t0ine34/diagramtool
Last synced: about 2 months ago
JSON representation
Python script for creating UML diagrams from source code.
- Host: GitHub
- URL: https://github.com/t0ine34/diagramtool
- Owner: T0ine34
- Created: 2024-09-30T16:02:24.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-22T17:31:07.000Z (6 months ago)
- Last Synced: 2025-04-09T22:56:37.336Z (about 2 months ago)
- Language: Python
- Homepage: https://pypi.org/project/diagramTool/
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Diagram Tool
## Description
Python script for creating UML diagrams from source code.
- Can parse multiple languages:
- Python
- Javascript (not yet implemented)
- Typescript (not yet implemented)
- Generate a SVG file with the diagram
## Usage
### Command Line
Use `diagramTool` command to generate the diagram.
```bash
diagramTool [options]
```
#### Options
use ```diagramTool --help``` to see the available options:
```
usage: DiagramTool [-h] [--debug] [--dump] [--save-ast] source output
create a class diagram from source code
positional arguments:
source source code main file
output output file
options:
-h, --help show this help message and exit
--debug print debug information
--dump dump parsed data to stdout
--save-ast save ast to file
```
### From Python
```python
import diagramTool as dt
dt.fromSource(source, output, save_ast=False, dump=False, showBorder=False)
```
## Example
Class diagram of this project generated with the tool.