Metadata-Version: 2.4
Name: dbmlviz
Version: 0.4.0
Summary: Converts DBML files to their graphviz representation in .dot format. It can also optionally do the additional conversion to an image format using graphviz.
Author-email: "Jason Rauen (badarsebard)" <jason.rauen@gmail.com>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/badarsebard/dbmlviz
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Information Technology
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydbml~=0.3.4
Requires-Dist: pydot~=1.4.2
Dynamic: license-file

# dbmlviz
Tool for creating visualization from dbml files.

Originally based on [dbml2dot](https://github.com/aviallon/dbml2dot) by Antoine VIALLON.

# Usage

## Using uvx (recommended)
```bash
# Run directly with uvx
uvx dbmlviz -h

# Or run from local directory
uvx --from . dbmlviz -h
```

## Using pip
```bash
pip install dbmlviz
dbmlviz -h
# Or run as module
python -m dbmlviz -h
```

### Example
```bash
# With uvx
uvx dbmlviz -i schema.dbml -o schema.dot --type svg

# With pip install
dbmlviz -i schema.dbml -o schema.dot --type svg
# Or
python -m dbmlviz -i schema.dbml -o schema.dot --type svg
```
This will output two files, one named `schema.dot` corresponding to the generated dot output,
and a svg file corresponding to the graph generated by graphviz.
