Update entity_relationship_generator.py

entity_relationship_generator.py

@@ -4,6 +4,198 @@ from tempfile import NamedTemporaryFile
 import os
 
 def generate_entity_relationship_diagram(json_input: str, output_format: str) -> str:
+    """
+    Generates an entity relationship diagram from JSON input.
+
+    Args:
+        json_input (str): A JSON string describing the entity relationship diagram structure.
+                          It must follow the Expected JSON Format Example below.
+
+    Expected JSON Format Example:
+    {
+      "entities": [
+        {
+          "name": "Customer",
+          "type": "strong",
+          "attributes": [
+            {"name": "customer_id", "type": "primary_key"},
+            {"name": "first_name", "type": "regular"},
+            {"name": "last_name", "type": "regular"},
+            {"name": "email", "type": "regular"},
+            {"name": "phone", "type": "multivalued", "multivalued": true},
+            {"name": "age", "type": "derived", "derived": true},
+            {"name": "address", "type": "composite", "composite": true}
+          ]
+        },
+        {
+          "name": "Order",
+          "type": "strong",
+          "attributes": [
+            {"name": "order_id", "type": "primary_key"},
+            {"name": "customer_id", "type": "foreign_key"},
+            {"name": "order_date", "type": "regular"},
+            {"name": "total_amount", "type": "regular"},
+            {"name": "status", "type": "regular"},
+            {"name": "shipping_address", "type": "composite", "composite": true}
+          ]
+        },
+        {
+          "name": "Product",
+          "type": "strong",
+          "attributes": [
+            {"name": "product_id", "type": "primary_key"},
+            {"name": "name", "type": "regular"},
+            {"name": "description", "type": "regular"},
+            {"name": "price", "type": "regular"},
+            {"name": "category_id", "type": "foreign_key"},
+            {"name": "stock_quantity", "type": "regular"}
+          ]
+        },
+        {
+          "name": "Category",
+          "type": "strong",
+          "attributes": [
+            {"name": "category_id", "type": "primary_key"},
+            {"name": "name", "type": "regular"},
+            {"name": "description", "type": "regular"},
+            {"name": "parent_category_id", "type": "foreign_key"}
+          ]
+        },
+        {
+          "name": "OrderItem",
+          "type": "weak",
+          "attributes": [
+            {"name": "order_id", "type": "primary_key"},
+            {"name": "product_id", "type": "primary_key"},
+            {"name": "quantity", "type": "regular"},
+            {"name": "unit_price", "type": "regular"},
+            {"name": "discount", "type": "regular"}
+          ]
+        },
+        {
+          "name": "Payment",
+          "type": "strong",
+          "attributes": [
+            {"name": "payment_id", "type": "primary_key"},
+            {"name": "order_id", "type": "foreign_key"},
+            {"name": "payment_method", "type": "regular"},
+            {"name": "amount", "type": "regular"},
+            {"name": "payment_date", "type": "regular"},
+            {"name": "transaction_id", "type": "regular"}
+          ]
+        },
+        {
+          "name": "Supplier",
+          "type": "strong",
+          "attributes": [
+            {"name": "supplier_id", "type": "primary_key"},
+            {"name": "company_name", "type": "regular"},
+            {"name": "contact_person", "type": "regular"},
+            {"name": "email", "type": "regular"},
+            {"name": "phone", "type": "multivalued", "multivalued": true},
+            {"name": "address", "type": "composite", "composite": true}
+          ]
+        },
+        {
+          "name": "Review",
+          "type": "weak",
+          "attributes": [
+            {"name": "customer_id", "type": "primary_key"},
+            {"name": "product_id", "type": "primary_key"},
+            {"name": "rating", "type": "regular"},
+            {"name": "comment", "type": "regular"},
+            {"name": "review_date", "type": "regular"}
+          ]
+        }
+      ],
+      "relationships": [
+        {
+          "name": "Places",
+          "type": "regular",
+          "entities": ["Customer", "Order"],
+          "cardinalities": {
+            "Customer": "1",
+            "Order": "N"
+          }
+        },
+        {
+          "name": "Contains",
+          "type": "identifying",
+          "entities": ["Order", "OrderItem"],
+          "cardinalities": {
+            "Order": "1",
+            "OrderItem": "N"
+          }
+        },
+        {
+          "name": "Includes",
+          "type": "regular",
+          "entities": ["OrderItem", "Product"],
+          "cardinalities": {
+            "OrderItem": "N",
+            "Product": "1"
+          }
+        },
+        {
+          "name": "BelongsTo",
+          "type": "regular",
+          "entities": ["Product", "Category"],
+          "cardinalities": {
+            "Product": "N",
+            "Category": "1"
+          }
+        },
+        {
+          "name": "ProcessedBy",
+          "type": "regular",
+          "entities": ["Order", "Payment"],
+          "cardinalities": {
+            "Order": "1",
+            "Payment": "1"
+          }
+        },
+        {
+          "name": "Supplies",
+          "type": "regular",
+          "entities": ["Supplier", "Product"],
+          "cardinalities": {
+            "Supplier": "N",
+            "Product": "M"
+          }
+        },
+        {
+          "name": "Writes",
+          "type": "weak",
+          "entities": ["Customer", "Review"],
+          "cardinalities": {
+            "Customer": "1",
+            "Review": "N"
+          }
+        },
+        {
+          "name": "ReviewsProduct",
+          "type": "weak",
+          "entities": ["Review", "Product"],
+          "cardinalities": {
+            "Review": "N",
+            "Product": "1"
+          }
+        },
+        {
+          "name": "Subcategory",
+          "type": "regular",
+          "entities": ["Category", "Category"],
+          "cardinalities": {
+            "Category": "1",
+            "Category": "N"
+          }
+        }
+      ]
+    }
+
+    Returns:
+        str: The filepath to the generated PNG image file.
+    """
     try:
         if not json_input.strip():
             return "Error: Empty input"