refactor: migrate API key storage from API_KEY.txt to activity_root/data

LLM.py

@@ -1,16 +1,52 @@
+import os
 import requests
 import json
 import socket
 import logging
 
-#TODO: Dont hard code these, need to see how sugar as a whole manages API Keys
+from sugar3.activity.activity import get_activity_root
+
 API_URL = "https://ai.sugarlabs.org/ask-llm-prompted"
-try:
-    with open("API_KEY.txt", "r") as f:
-        API_KEY = f.read().strip()
-except OSError:
-    logging.error("Missing API_KEY.txt file.")
-    API_KEY = None
+
+# Store and read the API key from the activity's persistent data directory
+# instead of a flat file in the bundle. The data/ subdirectory of
+# get_activity_root() survives across activity invocations and is the
+# Sugar-standard location for per-activity configuration.
+_API_KEY_FILENAME = "api_key"
+
+
+def _get_api_key_path():
+    """Return the path to the API key file inside activity_root/data/."""
+    data_dir = os.path.join(get_activity_root(), "data")
+    os.makedirs(data_dir, exist_ok=True)
+    return os.path.join(data_dir, _API_KEY_FILENAME)
+
+
+def _read_api_key():
+    """Read the API key from the activity data directory."""
+    path = _get_api_key_path()
+    try:
+        with open(path, "r") as f:
+            key = f.read().strip()
+            if key:
+                return key
+    except OSError:
+        pass
+    logging.error(
+        "Missing API key. Save your key to: %s", path
+    )
+    return None
+
+
+def save_api_key(key):
+    """Persist *key* so it is available on next launch."""
+    path = _get_api_key_path()
+    with open(path, "w") as f:
+        f.write(key.strip())
+    logging.info("API key saved to %s", path)
+
+
+API_KEY = _read_api_key()
 
 DEFAULT_PROMPT = "You are a friendly teacher named Jane who is 28 years old. You teach 10 year old children. Always give helpful, educational responses in simple words that children can understand. Keep your answers between 20-40 words. Be encouraging and enthusiastic but never use emojis(ever). If you notice spelling mistakes, gently correct them. Stay focused on the topic and give relevant answers."
 
@@ -25,7 +61,7 @@ def is_connected():
 
 def ask_llm_prompted(question, custom_prompt = DEFAULT_PROMPT, timeout=120, max_length=200):
     if API_KEY is None:
-        logging.error("Missing API key file: API_KEY.txt")
+        logging.error("Missing API key. Use save_api_key() or place it in activity_root/data/api_key")
         return False
 
     if not is_connected():
@@ -88,4 +124,4 @@ def ask_llm_prompted(question, custom_prompt = DEFAULT_PROMPT, timeout=120, max_
             print(f'LLM ANS: {answer}')
 
         else:
-            print("Error, LLM did not respond")
+            print("Error, LLM did not respond")

README.md

@@ -53,3 +53,22 @@ The `not-gstreamer1` branch is a backport of features and bug fixes
 from the `master` branch for ongoing maintenance of the activity on
 Fedora 18 systems which don't have well-functioning GStreamer 1
 packages.
+
+API Key Configuration
+=====================
+
+Speak-AI uses the [Sugar-AI](https://ai.sugarlabs.org/) backend for
+LLM-powered chatbot responses. An API key is required for this feature.
+
+The key is stored in the activity's persistent data directory
+(`<activity_root>/data/api_key`), which is the standard Sugar location
+for per-activity configuration that survives across sessions.
+
+To set up your API key, create the file manually:
+```
+echo "YOUR_API_KEY" > ~/.sugar/default/vu.lux.olpc.Speak/data/api_key
+```
+
+The exact path may vary depending on your Sugar profile. If the key is
+missing, the activity will log the expected path on startup and fall
+back to the on-device SLM or AIML brain.

activity.py

@@ -93,7 +93,7 @@
 except ImportError:
     USING_BRAIN = True
 
-from LLM import is_connected, ask_llm_prompted, DEFAULT_PROMPT
+from LLM import is_connected, ask_llm_prompted, DEFAULT_PROMPT, save_api_key
 from GenAI import is_profane
 
 SERVICE = 'org.sugarlabs.Speak'