Metadata-Version: 2.1
Name: DiagramTool
Version: 1.0.1
Summary: A tool to create diagrams from code
Author-email: Antoine Buirey <antoine.buirey@gmail.com>
Project-URL: homepage, https://github.com/T0ine34/DiagramTool
Project-URL: issues, https://github.com/T0ine34/DiagramTool/issues
Project-URL: source, https://github.com/T0ine34/DiagramTool
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: gamuLogger >=2.0.6
Requires-Dist: lxml >=4.6.3

# 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] <source> <output>
```

#### 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

![Example](example.svg)

Class diagram of this project generated with the tool.
