Update docstrings and remove unused imports

src/slidedeckai/core.py

@@ -1,5 +1,5 @@
 """
-Core functionality of SlideDeckAI.
+Core functionality of SlideDeck AI.
 """
 import logging
 import os

src/slidedeckai/helpers/chat_helper.py

@@ -1,12 +1,11 @@
 """
-Chat helper classes to replace LangChain components.
+Chat helper: message classes and history.
 """
-import streamlit as st
 
 
 class ChatMessage:
     """Base class for chat messages."""
-    
+
     def __init__(self, content: str, role: str):
         self.content = content
         self.role = role
@@ -34,11 +33,14 @@ class ChatMessageHistory:
         self.messages = []
     
     def add_user_message(self, content: str):
+        """Append user message to the history."""
         self.messages.append(HumanMessage(content))
     
     def add_ai_message(self, content: str):
+        """Append AI-generated response to the history."""
         self.messages.append(AIMessage(content))
 
+
 class ChatPromptTemplate:
     """Template for chat prompts."""
     

src/slidedeckai/helpers/llm_helper.py

@@ -3,7 +3,6 @@ Helper functions to access LLMs using LiteLLM.
 """
 import logging
 import re
-import sys
 import urllib3
 from typing import Tuple, Union, Iterator, Optional
 

src/slidedeckai/helpers/text_helper.py

@@ -8,10 +8,12 @@ def is_valid_prompt(prompt: str) -> bool:
     """
     Verify whether user input satisfies the concerned constraints.
 
-    :param prompt: The user input text.
-    :return: True if all criteria are satisfied; False otherwise.
-    """
+    Args:
+        prompt: The user input text.
 
+    Returns:
+        True if all criteria are satisfied; False otherwise.
+    """
     if len(prompt) < 7 or ' ' not in prompt:
         return False
 
@@ -24,10 +26,12 @@ def get_clean_json(json_str: str) -> str:
     trailing ``` and any text beyond that.
     CAUTION: May not be always accurate.
 
-    :param json_str: The input string in JSON format.
-    :return: The "cleaned" JSON string.
-    """
+    Args:
+        json_str: The input string in JSON format.
 
+    Returns:
+        The "cleaned" JSON string.
+    """
     response_cleaned = json_str
 
     if json_str.startswith('```json'):
@@ -55,10 +59,12 @@ def fix_malformed_json(json_str: str) -> str:
     """
     Try and fix the syntax error(s) in a JSON string.
 
-    :param json_str: The input JSON string.
-    :return: The fixed JSOn string.
-    """
+    Args:
+        json_str: The input JSON string.
 
+    Returns:
+        The fixed JSOn string.
+    """
     return jr.repair_json(json_str, skip_json_loads=True)