Update app.py

app.py

@@ -15,20 +15,20 @@ from urllib.parse import quote
 import streamlit as st
 import streamlit.components.v1 as components
 
-# (Optional) huggingface_hub usage if you do model inference
+# If you do model inference via huggingface_hub:
 from huggingface_hub import InferenceClient
 
-
 # ----------------------------
 # Configurable BASE_URL
 # ----------------------------
 BASE_URL = "https://huggingface.co/spaces/awacke1/MermaidMarkdownDiagramEditor"
 
-# Example placeholders
+# Example placeholders for prompt prefixes
 PromptPrefix = "AI-Search: "
 PromptPrefix2 = "AI-Refine: "
 PromptPrefix3 = "AI-JS: "
 
+# Example roleplaying glossary
 roleplaying_glossary = {
     "Core Rulebooks": {
         "Dungeons and Dragons": ["Player's Handbook", "Dungeon Master's Guide", "Monster Manual"],
@@ -39,11 +39,13 @@ roleplaying_glossary = {
     }
 }
 
+# Example transhuman glossary
 transhuman_glossary = {
     "Neural Interfaces": ["Cortex Jack", "Mind-Machine Fusion"],
     "Cybernetics": ["Robotic Limbs", "Augmented Eyes"],
 }
 
+# Simple function stubs
 def process_text(text):
     st.write(f"process_text called with: {text}")
 
@@ -59,7 +61,7 @@ def process_image(image_file, prompt):
 def process_video(video_file, seconds_per_frame):
     st.write(f"[process_video placeholder] Video: {video_file}, seconds/frame: {seconds_per_frame}")
 
-# Stub if you have a HF endpoint
+# Stub if you have a Hugging Face endpoint
 API_URL = "https://huggingface-inference-endpoint-placeholder"
 API_KEY = "hf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
 
@@ -72,6 +74,9 @@ def InferenceLLM(prompt):
 # ------------------------------------------
 @st.cache_resource
 def display_glossary_entity(k):
+    """
+    Creates multiple link emojis for a single entity.
+    """
     search_urls = {
         "🚀🌌ArXiv": lambda x: f"/?q={quote(x)}",
         "🃏Analyst": lambda x: f"/?q={quote(x)}-{quote(PromptPrefix)}",
@@ -87,6 +92,9 @@ def display_glossary_entity(k):
     st.markdown(f"**{k}** <small>{links_md}</small>", unsafe_allow_html=True)
 
 def display_content_or_image(query):
+    """
+    If a query matches something in transhuman_glossary or a local image, show it.
+    """
     for category, term_list in transhuman_glossary.items():
         for term in term_list:
             if query.lower() in term.lower():
@@ -101,9 +109,12 @@ def display_content_or_image(query):
     return False
 
 def clear_query_params():
+    """
+    For clearing URL params, you'd typically use a new link or st.experimental_set_query_params().
+    Here, we just warn the user. 
+    """
     st.warning("Define a redirect or link without query params if you want to truly clear them.")
 
-
 # -----------------------
 # File Handling
 # -----------------------
@@ -130,6 +141,9 @@ def get_zip_download_link(zip_file):
     return f'<a href="data:application/zip;base64,{b64}" download="{zip_file}">Download All</a>'
 
 def get_table_download_link(file_path):
+    """
+    Creates a download link for a single file from your snippet.
+    """
     try:
         with open(file_path, 'r', encoding='utf-8') as file:
             data = file.read()
@@ -154,7 +168,11 @@ def get_file_size(file_path):
     return os.path.getsize(file_path)
 
 def FileSidebar():
+    """
+    Renders .md files, providing open/view/delete/run logic in the sidebar.
+    """
     all_files = glob.glob("*.md")
+    # Exclude short-named or special files if needed
     all_files = [f for f in all_files if len(os.path.splitext(f)[0]) >= 5]
     all_files.sort(key=lambda x: (os.path.splitext(x)[1], x), reverse=True)
 
@@ -174,9 +192,9 @@ def FileSidebar():
     next_action = ''
 
     for file in all_files:
-        col1, col2, col3, col4, col5 = st.sidebar.columns([1,6,1,1,1])
+        col1, col2, col3, col4, col5 = st.sidebar.columns([1, 6, 1, 1, 1])
         with col1:
-            if st.button("🌐", key="md_"+file):
+            if st.button("🌐", key="md_" + file):
                 file_contents = load_file(file)
                 file_name = file
                 next_action = 'md'
@@ -184,7 +202,7 @@ def FileSidebar():
         with col2:
             st.markdown(get_table_download_link(file), unsafe_allow_html=True)
         with col3:
-            if st.button("📂", key="open_"+file):
+            if st.button("📂", key="open_" + file):
                 file_contents = load_file(file)
                 file_name = file
                 next_action = 'open'
@@ -193,16 +211,17 @@ def FileSidebar():
                 st.session_state['filetext'] = file_contents
                 st.session_state['next_action'] = next_action
         with col4:
-            if st.button("▶️", key="read_"+file):
+            if st.button("▶️", key="read_" + file):
                 file_contents = load_file(file)
                 file_name = file
                 next_action = 'search'
                 st.session_state['next_action'] = next_action
         with col5:
-            if st.button("🗑", key="delete_"+file):
+            if st.button("🗑", key="delete_" + file):
                 os.remove(file)
                 st.rerun()
 
+    # If we loaded a file
     if file_contents:
         if next_action == 'open':
             open1, open2 = st.columns([0.8, 0.2])
@@ -225,7 +244,7 @@ def FileSidebar():
         elif next_action == 'md':
             st.markdown(file_contents)
             SpeechSynthesis(file_contents)
-            if st.button('🔍Run'):
+            if st.button("🔍Run"):
                 st.write("Running GPT logic placeholder...")
 
 # ---------------------------
@@ -238,6 +257,9 @@ def generate_key(label, header, idx):
     return f"{header}_{label}_{idx}_key"
 
 def update_score(key, increment=1):
+    """
+    Track a 'score' for each glossary item or term, saved in JSON per key.
+    """
     score_file = os.path.join(score_dir, f"{key}.json")
     if os.path.exists(score_file):
         with open(score_file, "r") as file:
@@ -259,6 +281,9 @@ def load_score(key):
     return 0
 
 def display_buttons_with_scores(num_columns_text):
+    """
+    Show glossary items as clickable buttons that increment a 'score'.
+    """
     game_emojis = {
         "Dungeons and Dragons": "🐉",
         "Call of Cthulhu": "🐙",
@@ -288,9 +313,9 @@ def display_buttons_with_scores(num_columns_text):
             game_emoji = game_emojis.get(game, "🎮")
             for term in terms:
                 key = f"{category}_{game}_{term}".replace(' ', '_').lower()
-                score = load_score(key)
-                if st.button(f"{game_emoji} {category} {game} {term} {score}", key=key):
-                    newscore = update_score(key.replace('?',''))
+                score_val = load_score(key)
+                if st.button(f"{game_emoji} {category} {game} {term} {score_val}", key=key):
+                    newscore = update_score(key.replace('?', ''))
                     st.markdown(f"Scored **{category} - {game} - {term}** -> {newscore}")
 
 # -------------------------------
@@ -349,6 +374,9 @@ def display_videos_and_links(num_columns=4):
 # MERMAID DIAGRAM
 # --------------------------------
 def generate_mermaid_html(mermaid_code: str) -> str:
+    """
+    Returns HTML that centers the Mermaid diagram, loading from a CDN.
+    """
     return f"""
     <html>
     <head>
@@ -376,16 +404,24 @@ def generate_mermaid_html(mermaid_code: str) -> str:
     """
 
 def append_model_param(url: str, model_selected: bool) -> str:
+    """
+    If user checks 'Append ?model=1', we append &model=1 or ?model=1 if not present.
+    """
     if not model_selected:
         return url
     delimiter = "&" if "?" in url else "?"
     return f"{url}{delimiter}model=1"
 
 def inject_base_url(url: str) -> str:
+    """
+    If a link does not start with http, prepend your BASE_URL
+    so it becomes an absolute link to huggingface.co/spaces/...
+    """
     if url.startswith("http"):
         return url
     return f"{BASE_URL}{url}"
 
+# Our default diagram, containing the "click" lines with /?q=...
 DEFAULT_MERMAID = """
 flowchart LR
     U((User 😎)) -- "Talk 🗣️" --> LLM[LLM Agent 🤖\\nExtract Info]
@@ -405,15 +441,19 @@ flowchart LR
 def main():
     st.set_page_config(page_title="Mermaid + Clickable Links with Base URL", layout="wide")
 
-    # 1) Query Param Parsing
+    # ---------------------------------------------
+    # Query Param Parsing (non-experimental)
+    # ---------------------------------------------
     query_params = st.query_params
     query_list = (query_params.get('q') or query_params.get('query') or [''])
     q_or_query = query_list[0] if query_list else ''
     if q_or_query.strip():
+        # If there's a q= or query= param, do some processing
         search_payload = PromptPrefix + q_or_query
         st.markdown(search_payload)
         process_text(search_payload)
 
+    # If an 'action' param is present
     if 'action' in query_params:
         action_list = query_params['action']
         if action_list:
@@ -423,25 +463,38 @@ def main():
             elif action == 'clear':
                 clear_query_params()
 
+    # If a 'query' param is present, show content or image
     if 'query' in query_params:
         query_val = query_params['query'][0]
         display_content_or_image(query_val)
 
-    # 2) Let user pick if we want ?model=1
+    # ---------------------------------------------
+    # Let user pick if we want ?model=1
+    # ---------------------------------------------
     st.sidebar.write("## Diagram Link Settings")
     model_selected = st.sidebar.checkbox("Append ?model=1 to each link?")
 
-    # 3) Rebuild the clickable lines in the Mermaid code
+    # ---------------------------------------------
+    # Rebuild the clickable lines in the Mermaid code
+    # ---------------------------------------------
     base_diagram = DEFAULT_MERMAID
     lines = base_diagram.strip().split("\n")
     new_lines = []
+
     for line in lines:
+        # We look for lines like: click SOMENODE "/?q=Something" _self
         if "click " in line and '"/?' in line:
+            # Try to extract the URL part
             parts = re.split(r'click\s+\S+\s+"([^"]+)"\s+("_self")', line)
             if len(parts) == 4:
-                old_url = parts[1]   # e.g. '/?q=User%20😎'
+                # Example:
+                # parts[0] -> 'click LLM '
+                # parts[1] -> '/?q=LLM%20Agent%20Extract%20Info'
+                # parts[2] -> ' _self'
+                # parts[3] -> '' or trailing
+                old_url = parts[1]
                 # 1) Prepend base if needed
-                new_url = inject_base_url(old_url)  
+                new_url = inject_base_url(old_url)
                 # 2) Possibly add &model=1
                 new_url = append_model_param(new_url, model_selected)
 
@@ -449,21 +502,26 @@ def main():
                 new_line = f"{parts[0]}\"{new_url}\" {parts[2]}"
                 new_lines.append(new_line)
             else:
+                # If we can't parse it, keep it as is
                 new_lines.append(line)
         else:
             new_lines.append(line)
 
     mermaid_code = "\n".join(new_lines)
 
-    # 4) Render the top-centered Mermaid diagram
+    # ---------------------------------------------
+    # Render the top-centered Mermaid diagram
+    # ---------------------------------------------
     st.title("Mermaid Diagram with Base URL Injection")
     diagram_html = generate_mermaid_html(mermaid_code)
     components.html(diagram_html, height=400, scrolling=True)
 
-    # 5) Two-column interface: Markdown & Mermaid
+    # ---------------------------------------------
+    # Two-column interface: Markdown & Mermaid
+    # ---------------------------------------------
     left_col, right_col = st.columns(2)
 
-    # Left: Markdown Editor
+    # --- Left: Markdown Editor
     with left_col:
         st.subheader("Markdown Side 📝")
         if "markdown_text" not in st.session_state:
@@ -488,10 +546,11 @@ def main():
         st.markdown("**Preview:**")
         st.markdown(markdown_text)
 
-    # Right: Mermaid Editor
+    # --- Right: Mermaid Editor
     with right_col:
         st.subheader("Mermaid Side 🧜‍♂️")
 
+        # We store the final code in session state, so user can edit
         if "current_mermaid" not in st.session_state:
             st.session_state["current_mermaid"] = mermaid_code
 
@@ -516,24 +575,35 @@ def main():
         st.markdown("**Mermaid Source:**")
         st.code(mermaid_input, language="python", line_numbers=True)
 
-    # 6) Media Galleries
+    # ---------------------------------------------
+    # Media Galleries
+    # ---------------------------------------------
     st.markdown("---")
     st.header("Media Galleries")
+
     num_columns_images = st.slider("Choose Number of Image Columns", 1, 15, 5, key="num_columns_images")
     display_images_and_wikipedia_summaries(num_columns_images)
 
     num_columns_video = st.slider("Choose Number of Video Columns", 1, 15, 5, key="num_columns_video")
     display_videos_and_links(num_columns_video)
 
+    # (Optionally) Extended text interface
     showExtendedTextInterface = False
     if showExtendedTextInterface:
-        # e.g. display_glossary_grid, display_buttons_with_scores, etc.
+        # For example:
+        # display_glossary_grid(roleplaying_glossary)
+        # num_columns_text = st.slider("Choose Number of Text Columns", 1, 15, 4)
+        # display_buttons_with_scores(num_columns_text)
         pass
 
-    # 7) File Sidebar
+    # ---------------------------------------------
+    # File Sidebar
+    # ---------------------------------------------
     FileSidebar()
 
-    # 8) Random Title
+    # ---------------------------------------------
+    # Random Title at the bottom
+    # ---------------------------------------------
     titles = [
         "🧠🎭 Semantic Symphonies & Episodic Encores",
         "🌌🎼 AI Rhythms of Memory Lane",