Skip to content

Commit 2f8ad51

Browse files
Merge pull request #1 from FPVian/make-labels-optional
make labels optional
2 parents 8f20118 + a759803 commit 2f8ad51

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,11 @@ Then, simply call the `generate_data_model_diagram` function. This will generate
5959

6060
## API Documentation
6161

62-
### `generate_data_model_diagram(models, output_file='my_data_model_diagram')`
62+
### `generate_data_model_diagram(models, output_file='my_data_model_diagram', add_labels=True)`
6363

6464
- `models`: List of SQLAlchemy models you want to visualize.
6565
- `output_file`: Name of the output SVG file.
66+
- `add_labels`: Set to False to hide labels on the edges between tables
6667

6768
## Contributing
6869

sqlalchemy_data_model_visualizer.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
import re
1313
Base = declarative_base()
1414

15-
def generate_data_model_diagram(models, output_file='my_data_model_diagram'):
15+
def generate_data_model_diagram(models, output_file='my_data_model_diagram', add_labels=True):
1616
# Initialize graph with more advanced visual settings
1717
dot = graphviz.Digraph(comment='Interactive Data Models', format='svg',
1818
graph_attr={'bgcolor': '#EEEEEE', 'rankdir': 'TB', 'splines': 'spline'},
@@ -56,7 +56,7 @@ def generate_data_model_diagram(models, output_file='my_data_model_diagram'):
5656
for rel in insp.relationships:
5757
target_name = rel.mapper.class_.__name__
5858
tooltip = f"Relation between {name} and {target_name}"
59-
dot.edge(name, target_name, label=rel.key, tooltip=tooltip, color="#1E88E5", style="dashed")
59+
dot.edge(name, target_name, label=rel.key if add_labels else None, tooltip=tooltip, color="#1E88E5", style="dashed")
6060

6161
# Render the graph to a file and open it
6262
dot.render(output_file, view=True)
@@ -301,5 +301,5 @@ class GenericBillingInfo(Base):
301301

302302
output_file_name = 'my_data_model_diagram'
303303
# Generate the diagram and add interactivity
304-
generate_data_model_diagram(models, output_file_name)
304+
generate_data_model_diagram(models, output_file_name, add_labels=True)
305305
add_web_font_and_interactivity('my_data_model_diagram.svg', 'my_interactive_data_model_diagram.svg')

0 commit comments

Comments
 (0)