webscout 8.3.7__py3-none-any.whl → 2025.10.13__py3-none-any.whl

webscout/Provider/TTS/README.md

@@ -1,192 +1,192 @@
-# 🎙️ Webscout Text-to-Speech (TTS) Providers
-
-## Overview
-
-Webscout's TTS Providers offer a versatile and powerful text-to-speech conversion library with support for multiple providers and advanced features.
-
-## 🌟 Features
-
-- **Multiple TTS Providers**: Support for various text-to-speech services
-- **Concurrent Audio Generation**: Efficiently process long texts
-- **Flexible Voice Selection**: Choose from a wide range of voices
-- **Robust Error Handling**: Comprehensive logging and error management
-- **Temporary File Management**: Automatically manages temporary audio files
-- **Cross-Platform Compatibility**: Works seamlessly across different environments
-- **Custom Save Locations**: Save audio files to specific destinations
-- **Audio Streaming**: Stream audio data in chunks for real-time applications
-
-## 📦 Supported TTS Providers
-
-1. **ElevenlabsTTS**
-2. **GesseritTTS**
-3. **MurfAITTS**
-4. **ParlerTTS**
-5. **DeepgramTTS**
-6. **StreamElementsTTS**
-7. **SpeechMaTTS**
-9. **FreeTTS**
-## 🚀 Installation
-
-```bash
-pip install webscout
-```
-
-## 💻 Basic Usage
-
-```python
-from webscout.Provider.TTS import ElevenlabsTTS
-
-# Initialize the TTS provider
-tts = ElevenlabsTTS()
-
-# Generate speech from text
-text = "Hello, this is a test of text-to-speech conversion."
-audio_file = tts.tts(text, voice="Brian")
-
-# Save the audio to a specific location
-saved_path = tts.save_audio(audio_file, destination="my_speech.mp3")
-print(f"Audio saved to: {saved_path}")
-
-# Stream audio in chunks
-for chunk in tts.stream_audio(text, voice="Brian"):
-    # Process each chunk (e.g., send to a websocket, write to a stream, etc.)
-    process_audio_chunk(chunk)
-```
-
-## 🎛️ Advanced Configuration
-
-### Voice Selection
-
-Each TTS provider offers multiple voices:
-
-```python
-# List available voices
-print(tts.all_voices.keys())
-
-# Select a specific voice
-audio_file = tts.tts(text, voice="Alice")
-```
-
-### Verbose Logging
-
-Enable detailed logging for debugging:
-
-```python
-audio_file = tts.tts(text, verbose=True)
-```
-
-## 🔧 Provider-Specific Details
-
-### ElevenlabsTTS
-
-- Supports multiple English voices
-- Multilingual text-to-speech
-
-### GesseritTTS
-
-- Offers unique voice characteristics
-- Supports voice description customization
-
-### MurfAITTS
-
-- Provides specific voice models
-- Supports custom voice descriptions
-
-### ParlerTTS
-
-- Uses Gradio Client for TTS generation
-- Supports large and small model variants
-
-### DeepgramTTS
-
-- Multiple voice options
-- Advanced voice selection
-
-### StreamElementsTTS
-
-- Wide range of international voices
-
-### SpeechMaTTS
-
-- Multilingual voices (Ava, Emma, Andrew, Brian)
-- Adjustable pitch and speech rate
-- Fast audio generation
-
-## 🛡️ Error Handling
-
-```python
-try:
-    audio_file = tts.tts(text)
-except exceptions.FailedToGenerateResponseError as e:
-    print(f"TTS generation failed: {e}")
-```
-
-## 🌐 Proxy Support
-
-```python
-# Use with proxy
-tts = ElevenlabsTTS(proxies={
-    'http': 'http://proxy.example.com:8080',
-    'https': 'https://proxy.example.com:8080'
-})
-```
-
-## 💾 Custom Audio Saving
-
-Save generated audio to a specific location:
-
-```python
-# Generate speech
-audio_file = tts.tts(text, voice="Brian")
-
-# Save to a specific file
-tts.save_audio(audio_file, destination="path/to/output.mp3")
-
-# Save to a specific directory with default filename
-tts.save_audio(audio_file, destination="path/to/directory/")
-
-# Save with default location (current directory with timestamp)
-saved_path = tts.save_audio(audio_file)
-print(f"Saved to: {saved_path}")
-```
-
-## 📼 Audio Streaming
-
-Stream audio data in chunks for real-time applications:
-
-```python
-# Stream audio in chunks
-for chunk in tts.stream_audio(text, voice="Brian", chunk_size=2048):
-    # Example: Send to a websocket
-    websocket.send(chunk)
-
-    # Example: Write to an audio stream
-    audio_stream.write(chunk)
-
-    # Example: Process in real-time
-    process_audio_data(chunk)
-```
-
-## ⏱️ Async Support
-
-Use the async versions for non-blocking operations:
-
-```python
-from webscout.Provider.TTS import AsyncElevenlabsTTS
-import asyncio
-
-async def main():
-    tts = AsyncElevenlabsTTS()
-
-    # Generate speech
-    audio_file = await tts.tts(text, voice="Brian")
-
-    # Save to a specific location
-    saved_path = await tts.save_audio(audio_file, destination="output.mp3")
-
-    # Stream audio
-    async for chunk in tts.stream_audio(text, voice="Brian"):
-        await process_chunk(chunk)
-
-asyncio.run(main())
-```
+# 🎙️ Webscout Text-to-Speech (TTS) Providers
+
+## Overview
+
+Webscout's TTS Providers offer a versatile and powerful text-to-speech conversion library with support for multiple providers and advanced features.
+
+## 🌟 Features
+
+- **Multiple TTS Providers**: Support for various text-to-speech services
+- **Concurrent Audio Generation**: Efficiently process long texts
+- **Flexible Voice Selection**: Choose from a wide range of voices
+- **Robust Error Handling**: Comprehensive logging and error management
+- **Temporary File Management**: Automatically manages temporary audio files
+- **Cross-Platform Compatibility**: Works seamlessly across different environments
+- **Custom Save Locations**: Save audio files to specific destinations
+- **Audio Streaming**: Stream audio data in chunks for real-time applications
+
+## 📦 Supported TTS Providers
+
+1. **ElevenlabsTTS**
+2. **GesseritTTS**
+3. **MurfAITTS**
+4. **ParlerTTS**
+5. **DeepgramTTS**
+6. **StreamElementsTTS**
+7. **SpeechMaTTS**
+9. **FreeTTS**
+## 🚀 Installation
+
+```bash
+pip install webscout
+```
+
+## 💻 Basic Usage
+
+```python
+from webscout.Provider.TTS import ElevenlabsTTS
+
+# Initialize the TTS provider
+tts = ElevenlabsTTS()
+
+# Generate speech from text
+text = "Hello, this is a test of text-to-speech conversion."
+audio_file = tts.tts(text, voice="Brian")
+
+# Save the audio to a specific location
+saved_path = tts.save_audio(audio_file, destination="my_speech.mp3")
+print(f"Audio saved to: {saved_path}")
+
+# Stream audio in chunks
+for chunk in tts.stream_audio(text, voice="Brian"):
+    # Process each chunk (e.g., send to a websocket, write to a stream, etc.)
+    process_audio_chunk(chunk)
+```
+
+## 🎛️ Advanced Configuration
+
+### Voice Selection
+
+Each TTS provider offers multiple voices:
+
+```python
+# List available voices
+print(tts.all_voices.keys())
+
+# Select a specific voice
+audio_file = tts.tts(text, voice="Alice")
+```
+
+### Verbose Logging
+
+Enable detailed logging for debugging:
+
+```python
+audio_file = tts.tts(text, verbose=True)
+```
+
+## 🔧 Provider-Specific Details
+
+### ElevenlabsTTS
+
+- Supports multiple English voices
+- Multilingual text-to-speech
+
+### GesseritTTS
+
+- Offers unique voice characteristics
+- Supports voice description customization
+
+### MurfAITTS
+
+- Provides specific voice models
+- Supports custom voice descriptions
+
+### ParlerTTS
+
+- Uses Gradio Client for TTS generation
+- Supports large and small model variants
+
+### DeepgramTTS
+
+- Multiple voice options
+- Advanced voice selection
+
+### StreamElementsTTS
+
+- Wide range of international voices
+
+### SpeechMaTTS
+
+- Multilingual voices (Ava, Emma, Andrew, Brian)
+- Adjustable pitch and speech rate
+- Fast audio generation
+
+## 🛡️ Error Handling
+
+```python
+try:
+    audio_file = tts.tts(text)
+except exceptions.FailedToGenerateResponseError as e:
+    print(f"TTS generation failed: {e}")
+```
+
+## 🌐 Proxy Support
+
+```python
+# Use with proxy
+tts = ElevenlabsTTS(proxies={
+    'http': 'http://proxy.example.com:8080',
+    'https': 'https://proxy.example.com:8080'
+})
+```
+
+## 💾 Custom Audio Saving
+
+Save generated audio to a specific location:
+
+```python
+# Generate speech
+audio_file = tts.tts(text, voice="Brian")
+
+# Save to a specific file
+tts.save_audio(audio_file, destination="path/to/output.mp3")
+
+# Save to a specific directory with default filename
+tts.save_audio(audio_file, destination="path/to/directory/")
+
+# Save with default location (current directory with timestamp)
+saved_path = tts.save_audio(audio_file)
+print(f"Saved to: {saved_path}")
+```
+
+## 📼 Audio Streaming
+
+Stream audio data in chunks for real-time applications:
+
+```python
+# Stream audio in chunks
+for chunk in tts.stream_audio(text, voice="Brian", chunk_size=2048):
+    # Example: Send to a websocket
+    websocket.send(chunk)
+
+    # Example: Write to an audio stream
+    audio_stream.write(chunk)
+
+    # Example: Process in real-time
+    process_audio_data(chunk)
+```
+
+## ⏱️ Async Support
+
+Use the async versions for non-blocking operations:
+
+```python
+from webscout.Provider.TTS import AsyncElevenlabsTTS
+import asyncio
+
+async def main():
+    tts = AsyncElevenlabsTTS()
+
+    # Generate speech
+    audio_file = await tts.tts(text, voice="Brian")
+
+    # Save to a specific location
+    saved_path = await tts.save_audio(audio_file, destination="output.mp3")
+
+    # Stream audio
+    async for chunk in tts.stream_audio(text, voice="Brian"):
+        await process_chunk(chunk)
+
+asyncio.run(main())
+```

webscout/Provider/TTS/__init__.py

@@ -1,18 +1,33 @@
-# This file marks the directory as a Python package.
-
-import os
-import importlib
-from pathlib import Path
-
-# Get current directory
-current_dir = Path(__file__).parent
-
-# Auto-import all .py files (except __init__.py)
-for file_path in current_dir.glob("*.py"):
-    if file_path.name != "__init__.py":
-        module_name = file_path.stem
-        try:
-            module = importlib.import_module(f".{module_name}", package=__name__)
-            globals().update(vars(module))
-        except ImportError:
-            pass  # Skip files that can't be imported
+# This file marks the directory as a Python package.
+
+import os
+import importlib
+from pathlib import Path
+
+# Get current directory
+current_dir = Path(__file__).parent
+
+# List to store all exported names
+__all__ = []
+
+# Auto-import all .py files (except __init__.py)
+for file_path in current_dir.glob("*.py"):
+    if file_path.name != "__init__.py":
+        module_name = file_path.stem
+        try:
+            module = importlib.import_module(f".{module_name}", package=__name__)
+            
+            # Import the main class (assumes class name matches filename)
+            class_name = module_name
+            if hasattr(module, class_name):
+                globals()[class_name] = getattr(module, class_name)
+                __all__.append(class_name)
+            else:
+                # If no matching class, import all public attributes
+                for attr_name in dir(module):
+                    if not attr_name.startswith('_'):
+                        globals()[attr_name] = getattr(module, attr_name)
+                        if attr_name not in __all__:
+                            __all__.append(attr_name)
+        except ImportError:
+            pass  # Skip files that can't be imported

webscout/Provider/TTS/parler.py

@@ -1,111 +1,111 @@
-import time
-import tempfile
-from pathlib import Path
-from webscout import exceptions
-from gradio_client import Client
-import os
-from .base import BaseTTSProvider
-
-
-class ParlerTTS(BaseTTSProvider):
-    """
-    A class to interact with the Parler TTS API through Gradio Client.
-    """
-
-    def __init__(self, timeout: int = 20, proxies: dict = None):
-        """Initializes the Parler TTS client."""
-        super().__init__()
-        self.api_endpoint = "/gen_tts"
-        self.client = Client("parler-tts/parler_tts")  # Initialize the Gradio client
-        self.timeout = timeout
-
-    def tts(self, text: str, description: str = "", use_large: bool = False, verbose: bool = True) -> str:
-        """
-        Converts text to speech using the Parler TTS API.
-
-        Args:
-            text (str): The text to be converted to speech.
-            description (str, optional): Description of the desired voice characteristics. Defaults to "".
-            use_large (bool, optional): Whether to use the large model variant. Defaults to False.
-            verbose (bool, optional): Whether to log detailed information. Defaults to True.
-
-        Returns:
-            str: The filename of the saved audio file.
-
-        Raises:
-            exceptions.FailedToGenerateResponseError: If there is an error generating or saving the audio.
-        """
-        filename = Path(tempfile.mktemp(suffix=".wav", dir=self.temp_dir))
-
-        try:
-            if verbose:
-                print(f"[debug] Generating TTS with description: {description}")
-
-            result = self.client.predict(
-                text=text,
-                description=description,
-                use_large=use_large,
-                api_name=self.api_endpoint,
-            )
-
-            if isinstance(result, bytes):
-                audio_bytes = result
-            elif isinstance(result, str) and os.path.isfile(result):
-                with open(result, "rb") as f:
-                    audio_bytes = f.read()
-            else:
-                raise ValueError(f"Unexpected response from API: {result}")
-
-            self._save_audio(audio_bytes, filename, verbose)
-
-            if verbose:
-                print(f"[debug] Audio generated successfully: {filename}")
-
-            return filename.as_posix()
-
-        except Exception as e:
-            if verbose:
-                print(f"[debug] Error generating audio: {e}")
-            raise exceptions.FailedToGenerateResponseError(
-                f"Error generating audio after multiple retries: {e}"
-            ) from e
-
-    def _save_audio(self, audio_data: bytes, filename: Path, verbose: bool = True):
-        """
-        Saves the audio data to a WAV file.
-
-        Args:
-            audio_data (bytes): Audio data to save
-            filename (Path): Path to save the audio file
-            verbose (bool): Whether to print debug information
-
-        Raises:
-            exceptions.FailedToGenerateResponseError: If there is an error saving the audio.
-        """
-        try:
-            with open(filename, "wb") as f:
-                f.write(audio_data)
-            if verbose:
-                print(f"[debug] Audio saved to {filename}")
-
-        except Exception as e:
-            if verbose:
-                print(f"[debug] Error saving audio: {e}")
-            raise exceptions.FailedToGenerateResponseError(f"Error saving audio: {e}")
-
-# Example usage
-if __name__ == "__main__":
-    parlertts = ParlerTTS()
-    text = (
-        "All of the data, pre-processing, training code, and weights are released "
-        "publicly under a permissive license, enabling the community to build on our work "
-        "and develop their own powerful models."
-    )
-    voice_description = (
-        "Laura's voice is monotone yet slightly fast in delivery, with a very close "
-        "recording that almost has no background noise."
-    )
-
-    print("[debug] Generating audio...")
-    audio_file = parlertts.tts(text, description=voice_description, use_large=False)
+import time
+import tempfile
+from pathlib import Path
+from webscout import exceptions
+from gradio_client import Client
+import os
+from .base import BaseTTSProvider
+
+
+class ParlerTTS(BaseTTSProvider):
+    """
+    A class to interact with the Parler TTS API through Gradio Client.
+    """
+
+    def __init__(self, timeout: int = 20, proxies: dict = None):
+        """Initializes the Parler TTS client."""
+        super().__init__()
+        self.api_endpoint = "/gen_tts"
+        self.client = Client("parler-tts/parler_tts")  # Initialize the Gradio client
+        self.timeout = timeout
+
+    def tts(self, text: str, description: str = "", use_large: bool = False, verbose: bool = True) -> str:
+        """
+        Converts text to speech using the Parler TTS API.
+
+        Args:
+            text (str): The text to be converted to speech.
+            description (str, optional): Description of the desired voice characteristics. Defaults to "".
+            use_large (bool, optional): Whether to use the large model variant. Defaults to False.
+            verbose (bool, optional): Whether to log detailed information. Defaults to True.
+
+        Returns:
+            str: The filename of the saved audio file.
+
+        Raises:
+            exceptions.FailedToGenerateResponseError: If there is an error generating or saving the audio.
+        """
+        filename = Path(tempfile.mktemp(suffix=".wav", dir=self.temp_dir))
+
+        try:
+            if verbose:
+                print(f"[debug] Generating TTS with description: {description}")
+
+            result = self.client.predict(
+                text=text,
+                description=description,
+                use_large=use_large,
+                api_name=self.api_endpoint,
+            )
+
+            if isinstance(result, bytes):
+                audio_bytes = result
+            elif isinstance(result, str) and os.path.isfile(result):
+                with open(result, "rb") as f:
+                    audio_bytes = f.read()
+            else:
+                raise ValueError(f"Unexpected response from API: {result}")
+
+            self._save_audio(audio_bytes, filename, verbose)
+
+            if verbose:
+                print(f"[debug] Audio generated successfully: {filename}")
+
+            return filename.as_posix()
+
+        except Exception as e:
+            if verbose:
+                print(f"[debug] Error generating audio: {e}")
+            raise exceptions.FailedToGenerateResponseError(
+                f"Error generating audio after multiple retries: {e}"
+            ) from e
+
+    def _save_audio(self, audio_data: bytes, filename: Path, verbose: bool = True):
+        """
+        Saves the audio data to a WAV file.
+
+        Args:
+            audio_data (bytes): Audio data to save
+            filename (Path): Path to save the audio file
+            verbose (bool): Whether to print debug information
+
+        Raises:
+            exceptions.FailedToGenerateResponseError: If there is an error saving the audio.
+        """
+        try:
+            with open(filename, "wb") as f:
+                f.write(audio_data)
+            if verbose:
+                print(f"[debug] Audio saved to {filename}")
+
+        except Exception as e:
+            if verbose:
+                print(f"[debug] Error saving audio: {e}")
+            raise exceptions.FailedToGenerateResponseError(f"Error saving audio: {e}")
+
+# Example usage
+if __name__ == "__main__":
+    parlertts = ParlerTTS()
+    text = (
+        "All of the data, pre-processing, training code, and weights are released "
+        "publicly under a permissive license, enabling the community to build on our work "
+        "and develop their own powerful models."
+    )
+    voice_description = (
+        "Laura's voice is monotone yet slightly fast in delivery, with a very close "
+        "recording that almost has no background noise."
+    )
+
+    print("[debug] Generating audio...")
+    audio_file = parlertts.tts(text, description=voice_description, use_large=False)
     print(f"Audio saved to: {audio_file}")