separate from lesson graph class

app.py

@@ -1,157 +1,5 @@
 import gradio as gr
-import networkx as nx
-import matplotlib.pyplot as plt
-from io import BytesIO
-from PIL import Image
-import matplotlib.patches as mpatches
-import mplcursors
-import json
-
-class LessonGraph:
-    """
-    Class to handle the lesson plan graph construction and manipulation.
-    This encapsulates graph-related logic and avoids using global variables.
-    """
-
-    def __init__(self):
-        self.graph = nx.DiGraph()
-        self.color_map = {
-            "User": "#FF9999",  # Light Red
-            "Subject": "#66B2FF",  # Light Blue
-            "Grade Level": "#99FF99",  # Light Green
-            "Learning Objective": "#FFCC99",  # Light Orange
-            "Activity": "#FF99FF",  # Light Purple
-            "Assessment": "#FFFF99",  # Light Yellow
-            "Resource": "#99FFFF",  # Light Cyan
-            "School Board": "#CCCCCC"  # Light Gray
-        }
-
-    def add_lesson_plan(self, teacher_name, subject, grade_level, learning_objective, activity, assessment, resource, school_board):
-        """
-        Add nodes and edges to the lesson plan graph for the given inputs.
-        Returns a search string and the graph image.
-        """
-        self.graph.clear()  # Clear previous graph
-        
-        # Define node details and add them to the graph
-        nodes = {
-            teacher_name: {"type": "User", "role": "Teacher"},
-            subject: {"type": "Subject", "description": "Core subject area"},
-            grade_level: {"type": "Grade Level", "description": "Target grade for the lesson"},
-            learning_objective: {"type": "Learning Objective", "description": "Main goal of the lesson"},
-            activity: {"type": "Activity", "description": "Main class activity"},
-            assessment: {"type": "Assessment", "description": "Method of evaluating learning"},
-            resource: {"type": "Resource", "description": "Materials needed for the lesson"},
-            school_board: {"type": "School Board", "description": "Governing educational body"}
-        }
-
-        for node, attributes in nodes.items():
-            self.graph.add_node(node, **attributes)
-
-        # Define the relationships between nodes
-        self.graph.add_edges_from([
-            (teacher_name, subject, {"relationship": "TEACHES"}),
-            (subject, learning_objective, {"relationship": "COVERS"}),
-            (subject, grade_level, {"relationship": "HAS_GRADE"}),
-            (activity, learning_objective, {"relationship": "ACHIEVES"}),
-            (activity, resource, {"relationship": "REQUIRES"}),
-            (learning_objective, assessment, {"relationship": "EVALUATED_BY"}),
-            (teacher_name, school_board, {"relationship": "BELONGS_TO"}),
-            (learning_objective, school_board, {"relationship": "ALIGNS_WITH"})
-        ])
-
-        # Generate the search string for content discovery
-        search_string = f"{subject} {grade_level} {learning_objective} {activity} {resource}".strip()
-        
-        # Get the graph image
-        image = self.draw_graph()
-
-        # Return the search string and the graph image
-        return search_string, image
-
-    def draw_graph(self):
-        """
-        Visualize the graph using Matplotlib, handling layout, labels, and interactivity.
-        """
-        fig, ax = plt.subplots(figsize=(14, 10))
-        pos = nx.spring_layout(self.graph, k=0.9, iterations=50)
-
-        # Draw nodes with color coding
-        node_colors = [self.color_map[self.graph.nodes[node]['type']] for node in self.graph.nodes()]
-        nx.draw_networkx_nodes(self.graph, pos, node_color=node_colors, node_size=3000, alpha=0.8, ax=ax)
-        
-        # Draw edges and labels
-        nx.draw_networkx_edges(self.graph, pos, edge_color='gray', arrows=True, arrowsize=20, ax=ax)
-        nx.draw_networkx_labels(self.graph, pos, font_size=10, font_weight="bold", ax=ax)
-
-        edge_labels = nx.get_edge_attributes(self.graph, 'relationship')
-        nx.draw_networkx_edge_labels(self.graph, pos, edge_labels=edge_labels, font_size=8, ax=ax)
-        
-        # Add legend for node types
-        legend_elements = [mpatches.Patch(color=color, label=node_type) for node_type, color in self.color_map.items()]
-        plt.legend(handles=legend_elements, loc='upper left', bbox_to_anchor=(1, 1), title="Node Types")
-        
-        plt.title("Your Educational Landscape", fontsize=16)
-        plt.axis('off')
-        plt.tight_layout()
-        
-        # Add interactivity for hovering over nodes
-        cursor = mplcursors.cursor(hover=True)
-        @cursor.connect("add")
-        def on_add(sel):
-            node = list(self.graph.nodes())[sel.target.index]
-            node_data = self.graph.nodes[node]
-            sel.annotation.set_text(f"Node: {node}\nType: {node_data['type']}\n{node_data.get('description', '')}")
-        
-        # Save the plot to a BytesIO object
-        buf = BytesIO()
-        plt.savefig(buf, format="png", dpi=300, bbox_inches="tight")
-        buf.seek(0)
-        plt.close(fig)
-
-        return Image.open(buf)
-
-    def clear_graph(self):
-        """
-        Clears the lesson plan graph, allowing users to start fresh.
-        """
-        self.graph.clear()
-        return "Landscape cleared. You can start a new lesson plan."
-
-    def graph_to_json(self):
-        """
-        Converts the current lesson plan graph into a JSON string format and returns the result.
-
-        Returns:
-        - str: JSON string representation of the graph or an error message.
-        """
-        try:
-            # Convert the lesson_graph to a dictionary format
-            graph_data = {
-                "nodes": [
-                    {
-                        "id": node,
-                        "type": self.graph.nodes[node]["type"],
-                        "description": self.graph.nodes[node].get("description", "")
-                    }
-                    for node in self.graph.nodes()
-                ],
-                "edges": [
-                    {
-                        "source": u,
-                        "target": v,
-                        "relationship": self.graph.edges[u, v]["relationship"]
-                    }
-                    for u, v in self.graph.edges()
-                ]
-            }
-            
-            # Convert dictionary to JSON string
-            return json.dumps(graph_data, indent=4)
-
-        except Exception as e:
-            # If any error occurs, catch it and display it in the message_output
-            return f"An error occurred: {str(e)}"
+from lesson_graph import LessonGraph
 
 # Instantiate the LessonGraph class
 lesson_graph = LessonGraph()
@@ -164,20 +12,20 @@ with demo:
     gr.Markdown("Welcome to EduScape, where lesson planning becomes an adventure in crafting educational journeys. Design, visualize, and perfect your learning landscapes with ease.")
     
     with gr.Row():
-        teacher_name = gr.Textbox(label="Teacher Name")
-        school_board = gr.Textbox(label="School Board/Region")
+        teacher_name = gr.Textbox(label="Teacher Name (Required)", placeholder="Enter the teacher's full name", info="e.g., Sarah Johnson")
+        school_board = gr.Textbox(label="School Board/Region (Optional)", placeholder="Enter the school board or region", info="e.g., Oakville District School Board")
     
     with gr.Row():
-        subject = gr.Textbox(label="Subject")
-        grade_level = gr.Textbox(label="Grade Level")
+        subject = gr.Textbox(label="Subject (Required)", placeholder="Enter the subject name", info="e.g., Earth Science")
+        grade_level = gr.Textbox(label="Grade Level (Required)", placeholder="Enter the grade level", info="e.g., Grade 7")
     
     with gr.Row():
-        learning_objective = gr.Textbox(label="Learning Objective")
-        activity = gr.Textbox(label="Activity")
+        learning_objective = gr.Textbox(label="Learning Objective (Optional)", placeholder="Enter the main learning goal", info="e.g., Understand the water cycle and its impact on Earth's climate")
+        activity = gr.Textbox(label="Activity (Optional)", placeholder="Enter the main class activity", info="e.g., Create a terrarium to model the water cycle")
     
     with gr.Row():
-        assessment = gr.Textbox(label="Assessment")
-        resource = gr.Textbox(label="Resource/Material")
+        assessment = gr.Textbox(label="Assessment (Optional)", placeholder="Enter the assessment method", info="e.g., Group presentation on terrarium observations")
+        resource = gr.Textbox(label="Resource/Material (Optional)", placeholder="Enter required resources", info="e.g., Terrarium kit, climate diagrams")
     
     with gr.Row():
         generate_btn = gr.Button("Map Your Lesson Plan")
@@ -195,10 +43,17 @@ with demo:
     graph_output = gr.Image(label="Your Educational Landscape")
     message_output = gr.Textbox(label="Landscape Status")
     
+    def handle_generate(teacher_name, subject, grade_level, learning_objective, activity, assessment, resource, school_board):
+        try:
+            search_string, image = lesson_graph.process_inputs(teacher_name, subject, grade_level, learning_objective, activity, assessment, resource, school_board)
+            return search_string, image, "Lesson plan mapped successfully!"
+        except ValueError as e:
+            return "", None, f"Error: {str(e)}. Please fill in all required fields."
+
     generate_btn.click(
-        lesson_graph.add_lesson_plan, 
+        handle_generate, 
         inputs=[teacher_name, subject, grade_level, learning_objective, activity, assessment, resource, school_board],
-        outputs=[search_output, graph_output]
+        outputs=[search_output, graph_output, message_output]
     )
     
     graph_btn.click(
@@ -206,9 +61,13 @@ with demo:
         outputs=[message_output]
     )
 
+    def handle_reset():
+        reset_state = lesson_graph.reset_state()
+        return list(reset_state)
+
     clear_btn.click(
-        lesson_graph.clear_graph,
-        outputs=[search_output, graph_output, message_output]  # Pass all the outputs as a list
+        handle_reset,
+        outputs=[teacher_name, subject, grade_level, learning_objective, activity, assessment, resource, school_board, message_output]
     )
 
     # Add Markdown section explaining the purpose and use of the app
@@ -222,21 +81,25 @@ with demo:
     - **Graph Visualization**: Each element of the lesson plan is represented as a node, and the connections between these elements (like how an activity achieves the learning objective) are visualized through edges.
     - **Content Discovery**: The system generates a search string based on input, which can help the teacher discover content or resources to support their lesson plan.
 
+    ### Required and Optional Fields:
+    - **Required Fields**: Teacher Name, Subject, and Grade Level
+    - **Optional Fields**: Learning Objective, Activity, Assessment, Resource/Material, and School Board/Region
+
     ### Logical Flow of the Knowledge Graph:
     1. The **Teacher** node connects to the **Subject** node (representing what the teacher teaches).
-    2. The **Subject** node connects to both the **Grade Level** and **Learning Objective** (defining what is taught and to whom).
-    3. The **Activity** node links to the **Learning Objective** (showing how the objective is achieved through student engagement).
-    4. The **Assessment** node connects to the **Learning Objective** (indicating how learning is evaluated).
-    5. The **Resource** node connects to the **Activity** (detailing what materials are needed for the activity).
-    6. The **Teacher** also connects to the **School Board** (showing which governing body the teacher belongs to).
-    7. The **Learning Objective** aligns with **School Board** standards (ensuring that the lesson adheres to curriculum requirements).
+    2. The **Subject** node connects to the **Grade Level** (defining what is taught and to whom).
+    3. If provided, the **Learning Objective** node links to the **Subject** (showing what specific goal is covered).
+    4. If both are provided, the **Activity** node links to the **Learning Objective** (showing how the objective is achieved through student engagement).
+    5. If provided, the **Assessment** node connects to the **Learning Objective** (indicating how learning is evaluated).
+    6. If both are provided, the **Resource** node connects to the **Activity** (detailing what materials are needed for the activity).
+    7. If provided, the **Teacher** also connects to the **School Board** (showing which governing body the teacher belongs to).
+    8. If both are provided, the **Learning Objective** aligns with **School Board** standards (ensuring that the lesson adheres to curriculum requirements).
 
     ### Example Use Case:
-    A teacher, Sarah Johnson, inputs her lesson plan for Grade 7 Earth Science focused on understanding the water cycle. She adds an activity where students create a terrarium and a group presentation for assessment. The system visualizes the relationships between these elements in the graph and generates a content discovery string to help her find additional resources like a terrarium kit or climate diagrams. 
+    A teacher, Sarah Johnson, inputs her lesson plan for Grade 7 Earth Science. She must provide her name, the subject, and the grade level. Optionally, she can add a learning objective about understanding the water cycle, an activity to create a terrarium, a group presentation for assessment, and specify resources like a terrarium kit. The system visualizes the relationships between these elements in the graph and generates a content discovery string to help her find additional resources.
 
-    EduScape ensures that teachers can organize their lessons effectively while aligning with the curriculum and discovering resources to enhance their lesson delivery.
+    EduScape ensures that teachers can organize their lessons effectively while aligning with the curriculum and discovering resources to enhance their lesson delivery, with flexibility to include as much or as little detail as they prefer.
     """)
-    
-# Launch the EduScape app
-demo.launch()
 
+# Launch the EduScape app
+demo.launch()