Skip to content

Commit 8f20118

Browse files
Update README.md
1 parent 7959ef1 commit 8f20118

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,19 @@ This Python-based utility generates high-quality, readable visualizations of you
1616
- Table-like representation of each model with fields, types, and constraints.
1717
- Export diagrams to SVG format for high-quality viewing and printing using Roboto font.
1818

19-
## Installation
19+
## Installation with pip and Usage:
20+
21+
```bash
22+
pip install sqlalchemy-data-model-visualizer
23+
24+
# Suppose these are your SQLAlchemy data models defined above in the usual way, or imported from another file:
25+
models = [GenericUser, Customer, ContentCreator, UserSession, FileStorage, ServiceRequest, GenericAuditLog, GenericFeedback, GenericAPIKey, GenericNotification, GenericAPICreditLog, GenericSubscriptionType, GenericSubscription, GenericSubscriptionUsage, GenericBillingInfo]
26+
output_file_name = 'my_data_model_diagram'
27+
generate_data_model_diagram(models, output_file_name)
28+
add_web_font_and_interactivity('my_data_model_diagram.svg', 'my_interactive_data_model_diagram.svg')
29+
```
30+
31+
## Installation from Source
2032

2133
To get started, clone the repository and install the required packages.
2234

0 commit comments

Comments
 (0)