async-easy-model 0.2.3__py3-none-any.whl → 0.2.5__py3-none-any.whl

{async_easy_model-0.2.3.dist-info → async_easy_model-0.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: async-easy-model
-Version: 0.2.3
+Version: 0.2.5
 Summary: A simplified SQLModel-based ORM for async database operations
 Home-page: https://github.com/puntorigen/easy-model
 Author: Pablo Schaffner
@@ -59,6 +59,7 @@ A simplified SQLModel-based ORM for async database operations in Python. async-e
 - 📝 Type hints for better IDE support
 - 🕒 Automatic `id`, `created_at` and `updated_at` fields provided by default
 - 🔄 Automatic schema migrations for evolving database models
+- 📊 Visualization of database schema using Mermaid ER diagrams
 
 ## Installation
 
@@ -250,6 +251,89 @@ deleted_count = await User.delete({"is_active": False})
 await Post.delete({"user": {"username": "john_doe"}, "is_published": False})
 ```
 
+## Database Schema Visualization
+
+The package includes a `ModelVisualizer` class that makes it easy to generate Entity-Relationship (ER) diagrams for your database models using Mermaid syntax.
+
+```python
+from async_easy_model import EasyModel, init_db, db_config, ModelVisualizer
+
+# Initialize your models and database
+await init_db()
+
+# Create a visualizer
+visualizer = ModelVisualizer()
+
+# Generate a Mermaid ER diagram
+er_diagram = visualizer.mermaid()
+print(er_diagram)
+
+# Generate a shareable link to view the diagram online
+er_link = visualizer.mermaid_link()
+print(er_link)
+
+# Customize the diagram title
+visualizer.set_title("My Project Database Schema")
+custom_diagram = visualizer.mermaid()
+```
+
+### Example Mermaid ER Diagram Output
+
+```mermaid
+---
+title: EasyModel Table Schemas
+config:
+    layout: elk
+---
+erDiagram
+    author {
+        number id PK
+        string name "required"
+        string email
+    }
+    book {
+        number id PK
+        string title "required"
+        number author_id FK
+        string isbn
+        number published_year
+        author author "virtual"
+        tag[] tags "virtual"
+    }
+    tag {
+        number id PK
+        string name "required"
+        book[] books "virtual"
+    }
+    book_tag {
+        number id PK
+        number book_id FK "required"
+        number tag_id FK "required"
+        book book "virtual"
+        tag tag "virtual"
+    }
+    review {
+        number id PK
+        number book_id FK "required"
+        number rating "required"
+        string comment
+        string reviewer_name "required"
+        book book "virtual"
+    }
+    book ||--o{ author : "author_id"
+    book_tag ||--o{ book : "book_id"
+    book_tag ||--o{ tag : "tag_id"
+    book }o--o{ tag : "many-to-many"
+    review ||--o{ book : "book_id"
+```
+
+The diagram automatically:
+- Shows all tables with their fields and data types
+- Identifies primary keys (PK) and foreign keys (FK)
+- Shows required fields and virtual relationships
+- Visualizes relationships between tables with proper cardinality
+- Properly handles many-to-many relationships
+
 ## Convenient Query Methods
 
 async-easy-model provides simplified methods for common query patterns:

async_easy_model-0.2.5.dist-info/RECORD

@@ -0,0 +1,11 @@
+async_easy_model/__init__.py,sha256=cpv45_jab9WbuemZehABoXL64VZ19R-L4-UOAbj8sls,1739
+async_easy_model/auto_relationships.py,sha256=V2LAzNi7y-keFk4C_m-byVRM-k_7nL5HEy9Ig3nEdq8,27756
+async_easy_model/migrations.py,sha256=rYDGCGlruSugAmPfdIF2-uhyG6UvC_2qbF3BXJ084qI,17803
+async_easy_model/model.py,sha256=Vq6NTUThuEKy_CVLAb6Dy5pcDjbBr49qgamTQj5GtZ0,63284
+async_easy_model/relationships.py,sha256=vR5BsJpGaDcecCcNlg9-ouZfxFXFQv5kOyiXhKp_T7A,3286
+async_easy_model/visualization.py,sha256=VdW89D103sF7nnB1BG3EnGcID1HF-1TVr_U0iaOuFjA,27355
+async_easy_model-0.2.5.dist-info/LICENSE,sha256=uwDkl6oHbRltW7vYKNc4doJyhtwhyrSNFFlPpKATwLE,1072
+async_easy_model-0.2.5.dist-info/METADATA,sha256=G6Ol1O_uihhCchSJnf0dCHEP0G3NEl4Nd_pBJwOoKiA,12866
+async_easy_model-0.2.5.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+async_easy_model-0.2.5.dist-info/top_level.txt,sha256=e5_47sGmJnyxz2msfwU6C316EqmrSd9RGIYwZyWx68E,17
+async_easy_model-0.2.5.dist-info/RECORD,,

async_easy_model-0.2.3.dist-info/RECORD

@@ -1,10 +0,0 @@
-async_easy_model/__init__.py,sha256=u1yerriPm93E_uXcK9r-y7wcMOV1F4t-KjKEooCaiIA,1642
-async_easy_model/auto_relationships.py,sha256=VetxcrOdKGGSImTiysRFR8PSOSlo50RqnVG95CLe8Jg,22433
-async_easy_model/migrations.py,sha256=rYDGCGlruSugAmPfdIF2-uhyG6UvC_2qbF3BXJ084qI,17803
-async_easy_model/model.py,sha256=G-0htjy78Nae5HdNE2dMGV8Z8s-rUNRTUANcKArxrDM,57852
-async_easy_model/relationships.py,sha256=vR5BsJpGaDcecCcNlg9-ouZfxFXFQv5kOyiXhKp_T7A,3286
-async_easy_model-0.2.3.dist-info/LICENSE,sha256=uwDkl6oHbRltW7vYKNc4doJyhtwhyrSNFFlPpKATwLE,1072
-async_easy_model-0.2.3.dist-info/METADATA,sha256=SZJy5Ozs7Jn-J3qVTiVB637IGza-5C6hdet_dPocM3I,10720
-async_easy_model-0.2.3.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-async_easy_model-0.2.3.dist-info/top_level.txt,sha256=e5_47sGmJnyxz2msfwU6C316EqmrSd9RGIYwZyWx68E,17
-async_easy_model-0.2.3.dist-info/RECORD,,