Clean up documentation, remove orphaned utility, create constants file to store constants

src/config.py

@@ -7,10 +7,6 @@ constants and settings, such as the logging configuration and API constraints.
 Key Features:
 - Configures the logger for consistent logging across all modules.
 - Dynamically sets the logging level based on the DEBUG environment variable.
-- Provides constants for shared constraints like maximum prompt length.
-
-Constants:
-- DEBUG: Indicates whether debug mode is enabled.
 """
 
 # Standard Library Imports
@@ -39,17 +35,5 @@ logging.basicConfig(
 logger: logging.Logger = logging.getLogger('tts_arena')
 logger.info(f'Debug mode is {"enabled" if DEBUG else "disabled"}.')
 
-
-# Log environment variables
-def log_env_variable(var_name: str, value: str) -> None:
-    """
-    Logs the value of an environment variable for debugging purposes.
-
-    Args:
-        var_name (str): The name of the environment variable.
-        value (str): The value of the environment variable.
-    """
-    logger.debug(f'Environment variable "{var_name}" validated with value: {value}')
-
 if DEBUG:
     logger.debug(f'DEBUG mode enabled.')

src/{sample_prompts.py → constants.py}

@@ -1,10 +1,14 @@
 """
-sample_prompts.py
+constants.py
 
-This file contains predefined sample prompts to showcase the expressiveness of TTS models.
-These prompts are structured to highlight different aspects of emotional tone, pacing, and rhythm.
+This module defines global constants used throughout the project.
 """
 
+# Minimum and maximum prompt length constraints
+PROMPT_MIN_LENGTH: int = 10
+PROMPT_MAX_LENGTH: int = 300
+
+# A collection of pre-defined prompts categorized by theme, used to provide users with inspiration for generating creative text.
 SAMPLE_PROMPTS = {
     '🚀 Dramatic Monologue (Stranded Astronaut)': 
         'Write a short dramatic monologue from a lone astronaut stranded on Mars, '

src/integrations/anthropic_api.py

@@ -12,8 +12,8 @@ Key Features:
 - Provides detailed logging for debugging and error tracking.
 
 Classes:
+- AnthropicConfig: Immutable configuration for interacting with the TTS API.
 - AnthropicError: Custom exception for Anthropic API-related errors.
-- SystemPrompt: Frozen dataclass for storing the system prompt, ensuring immutability.
 
 Functions:
 - generate_text_with_claude: Generates text using the Anthropic SDK with input validation and retry logic.
@@ -40,7 +40,7 @@ class AnthropicConfig:
     """
     api_key: str = validate_env_var('ANTHROPIC_API_KEY')
     model: ModelParam = 'claude-3-5-sonnet-latest' # Valid predefined model
-    max_tokens: int = 300 # Max tokens for API response
+    max_tokens: int = 256 # Max tokens for API response
     system_prompt: str = """You are a highly creative and articulate assistant specialized in generating vivid, engaging, and well-written content.
 
 Your task is to respond to user prompts by creating:

src/integrations/elevenlabs_api.py

@@ -11,8 +11,8 @@ Key Features:
 - Provides detailed logging for debugging and error tracking.
 
 Classes:
-- ElevenLabsException: Custom exception for TTS API-related errors.
 - ElevenLabsConfig: Immutable configuration for interacting with the TTS API.
+- ElevenLabsException: Custom exception for TTS API-related errors.
 
 Functions:
 - text_to_speech_with_elevenlabs: Converts text to speech using the ElevenLabs TTS API.

src/integrations/hume_api.py

@@ -11,8 +11,8 @@ Key Features:
 - Provides detailed logging for debugging and error tracking.
 
 Classes:
-- HumeException: Custom exception for TTS API-related errors.
 - HumeConfig: Immutable configuration for interacting with the TTS API.
+- HumeException: Custom exception for TTS API-related errors.
 
 Functions:
 - text_to_speech_with_hume: Converts text to speech using the Hume TTS API with input validation and retry logic.