Skip to content

Commit 77fa3eb

Browse files
Update README.md
1 parent eccc732 commit 77fa3eb

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
## Overview
44

5-
This Python-based utility generates high-quality, readable visualizations of your SQLAlchemy ORM models. With a focus on clarity and detail, it uses Graphviz to render each model as a directed graph, making it easier to understand the relationships between tables in your database schema.
5+
This Python-based utility generates high-quality, readable visualizations of your SQLAlchemy ORM models with almost no effort. With a focus on clarity and detail, it uses Graphviz to render each model as a directed graph, making it easier to understand the relationships between tables in your database schema.
6+
7+
![Example Data Model Diagram](https://raw.githubusercontent.com/Dicklesworthstone/sqlalchemy_data_model_visualizer/main/my_interactive_data_model_diagram.svg)
68

79
## Features
810

911
- Automatically maps SQLAlchemy ORM models to a directed graph.
1012
- Table-like representation of each model with fields, types, and constraints.
11-
- Visual cues for primary keys, unique fields, and indexed fields.
12-
- Export diagrams to SVG format for high-quality viewing and printing.
13+
- Export diagrams to SVG format for high-quality viewing and printing using Roboto font.
1314

1415
## Installation
1516

@@ -18,6 +19,10 @@ To get started, clone the repository and install the required packages.
1819
```bash
1920
git clone https://github.com/Dicklesworthstone/sqlalchemy_data_model_visualizer.git
2021
cd sqlalchemy_data_model_visualizer
22+
python3 -m venv venv
23+
source venv/bin/activate
24+
python3 -m pip install --upgrade pip
25+
python3 -m pip install wheel
2126
pip install -r requirements.txt
2227
```
2328

0 commit comments

Comments
 (0)