webscout 8.3.4__tar.gz → 8.3.6__tar.gz

{webscout-8.3.4/webscout.egg-info → webscout-8.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webscout
-Version: 8.3.4
+Version: 8.3.6
 Summary: Search for anything using Google, DuckDuckGo, phind.com, Contains AI models, can transcribe yt videos, temporary email and phone number generation, has TTS support, webai (terminal gpt and open interpreter) and offline LLMs and more
 Author-email: OEvortex <helpingai5@gmail.com>
 License: HelpingAI
@@ -41,7 +41,6 @@ Requires-Dist: nodriver
 Requires-Dist: mistune
 Requires-Dist: curl_cffi
 Requires-Dist: nest-asyncio
-Requires-Dist: websocket-client
 Requires-Dist: colorama
 Requires-Dist: rich
 Requires-Dist: markdownify
@@ -73,6 +72,8 @@ Requires-Dist: python-multipart; extra == "api"
 Requires-Dist: tiktoken; extra == "api"
 Requires-Dist: motor; extra == "api"
 Requires-Dist: jinja2; extra == "api"
+Requires-Dist: supabase; extra == "api"
+Requires-Dist: websockets>=11.0; extra == "api"
 Dynamic: license-file
 
 <div align="center">
@@ -105,7 +106,7 @@ Dynamic: license-file
 - [🌟 Key Features](#-features)
 - [⚙️ Installation](#️-installation)
 - [🖥️ Command Line Interface](#️-command-line-interface)
-- [🔄 OpenAI-Compatible API Server](#-openai-compatible-api-server)
+- [🔄 OpenAI-Compatible API Server](docs/openai-api-server.md)
 - [🔍 Search Engines](#-search-engines)
 - [🦆 DuckDuckGo Search](#-duckduckgo-search-with-webs-and-asyncwebs)
 - [💻 WEBS API Reference](#-webs-api-reference)
@@ -117,7 +118,7 @@ Dynamic: license-file
 
 <hr/>
 
-> [!IMPORTANT] >
+> [!IMPORTANT]
 > **Webscout supports three types of compatibility:**
 >
 > - **Native Compatibility:** Webscout's own native API for maximum flexibility
@@ -181,6 +182,8 @@ Dynamic: license-file
 - **[Scout](webscout/scout/README.md):** Advanced web parsing and crawling library with intelligent HTML/XML parsing
 - **[Inferno](https://github.com/HelpingAI/inferno):** Run local LLMs with an OpenAI-compatible API and interactive CLI (now a standalone package: `pip install inferno-llm`)
 - **[GGUF Conversion](webscout/Extra/gguf.md):** Convert and quantize Hugging Face models to GGUF format
+- **[Utility Decorators](docs/decorators.md):** Easily measure function execution time (`timeIt`) and add retry logic (`retry`) to any function
+- **[Stream Sanitization Utilities](docs/sanitize.md):** Advanced tools for cleaning, decoding, and processing data streams
 </p>
 </details>
 
@@ -381,7 +384,8 @@ For more information, visit the [Inferno GitHub repository](https://github.com/H
 </p>
 </details>
 
-> [!NOTE] > **Hardware requirements for running models with Inferno:**
+> [!NOTE]  
+> **Hardware requirements for running models with Inferno:**
 >
 > - Around 2 GB of RAM for 1B models
 > - Around 4 GB of RAM for 3B models
@@ -390,150 +394,7 @@ For more information, visit the [Inferno GitHub repository](https://github.com/H
 > - 32 GB of RAM for 33B models
 > - GPU acceleration is recommended for better performance
 
-<details open>
-<summary><b>🔄 OpenAI-Compatible API Server</b></summary>
-<p>
-
-Webscout includes an OpenAI-compatible API server that allows you to use any supported provider with tools and applications designed for OpenAI's API.
-
-### Starting the API Server
-
-#### From Command Line (Recommended)
-
-```bash
-# Start with default settings (port 8000)
-webscout-server
-
-# Start with custom port
-webscout-server --port 8080
-
-# Start with API key authentication
-webscout-server --api-key "your-secret-key"
-
-# Start in no-auth mode using command line flag (no API key required)
-webscout-server --no-auth
-
-# Start in no-auth mode using environment variable
-$env:WEBSCOUT_NO_AUTH='true'; webscout-server
-
-# Specify a default provider
-webscout-server --default-provider "Claude"
-
-# Run in debug mode
-webscout-server --debug
-
-# Get help for all options (includes authentication options)
-webscout-server --help
-```
-
-#### Alternative Methods
-
-```bash
-# Using UV (no installation required)
-uv run --extra api webscout-server
-
-# Using Python module
-python -m webscout.auth.server
-```
-
-#### Environment Variables
-
-Webscout server supports configuration through environment variables:
-
-```bash
-# Start server in no-auth mode (no API key required)
-$env:WEBSCOUT_NO_AUTH='true'; webscout-server
-
-# Disable rate limiting
-$env:WEBSCOUT_NO_RATE_LIMIT='true'; webscout-server
-
-# Start with custom port using environment variable
-$env:WEBSCOUT_PORT='7860'; webscout-server
-```
-
-For a complete list of supported environment variables and Docker deployment options, see [DOCKER.md](DOCKER.md).
-
-#### From Python Code
-
-> **Recommended:**  
-> Use `start_server` from `webscout.client` for the simplest programmatic startup.  
-> For advanced control (custom host, debug, etc.), use `run_api`.
-
-```python
-# Method 1: Using the helper function (recommended)
-from webscout.client import start_server
-
-# Start with default settings
-start_server()
-
-# Start with custom settings
-start_server(port=8080, api_key="your-secret-key", default_provider="Claude")
-
-# Start in no-auth mode (no API key required)
-start_server(no_auth=True)
-
-# Method 2: Advanced usage with run_api
-from webscout.client import run_api
-
-run_api(
-    host="0.0.0.0",
-    debug=True
-)
-```
-
-### Using the API
-
-Once the server is running, you can use it with any OpenAI client library or tool:
-
-```python
-# Using the OpenAI Python client
-from openai import OpenAI
-
-client = OpenAI(
-    api_key="your-secret-key",  # Only needed if you set an API key
-    base_url="http://localhost:8000/v1"  # Point to your local server
-)
-
-# Chat completion
-response = client.chat.completions.create(
-    model="gpt-4",  # This can be any model name registered with Webscout
-    messages=[
-        {"role": "system", "content": "You are a helpful assistant."},
-        {"role": "user", "content": "Hello, how are you?"}
-    ]
-)
-
-print(response.choices[0].message.content)
-```
-
-### Using with cURL
-
-```bash
-# Basic chat completion request
-curl http://localhost:8000/v1/chat/completions \
-  -H "Content-Type: application/json" \
-  -H "Authorization: Bearer your-secret-key" \
-  -d '{
-    "model": "gpt-4",
-    "messages": [
-      {"role": "system", "content": "You are a helpful assistant."},
-      {"role": "user", "content": "Hello, how are you?"}
-    ]
-  }'
-
-# List available models
-curl http://localhost:8000/v1/models \
-  -H "Authorization: Bearer your-secret-key"
-```
-
-### Available Endpoints
-
-- `GET /v1/models` - List all available models
-- `GET /v1/models/{model_name}` - Get information about a specific model
-- `POST /v1/chat/completions` - Create a chat completion
-
-</p>
-</details>
+For detailed information about the OpenAI-compatible API server, including setup, configuration, and usage examples, see the [OpenAI API Server Documentation](docs/openai-api-server.md).
 
 <hr/>
 

{webscout-8.3.4 → webscout-8.3.6}/README.md

@@ -28,7 +28,7 @@
 - [🌟 Key Features](#-features)
 - [⚙️ Installation](#️-installation)
 - [🖥️ Command Line Interface](#️-command-line-interface)
-- [🔄 OpenAI-Compatible API Server](#-openai-compatible-api-server)
+- [🔄 OpenAI-Compatible API Server](docs/openai-api-server.md)
 - [🔍 Search Engines](#-search-engines)
 - [🦆 DuckDuckGo Search](#-duckduckgo-search-with-webs-and-asyncwebs)
 - [💻 WEBS API Reference](#-webs-api-reference)
@@ -40,7 +40,7 @@
 
 <hr/>
 
-> [!IMPORTANT] >
+> [!IMPORTANT]
 > **Webscout supports three types of compatibility:**
 >
 > - **Native Compatibility:** Webscout's own native API for maximum flexibility
@@ -104,6 +104,8 @@
 - **[Scout](webscout/scout/README.md):** Advanced web parsing and crawling library with intelligent HTML/XML parsing
 - **[Inferno](https://github.com/HelpingAI/inferno):** Run local LLMs with an OpenAI-compatible API and interactive CLI (now a standalone package: `pip install inferno-llm`)
 - **[GGUF Conversion](webscout/Extra/gguf.md):** Convert and quantize Hugging Face models to GGUF format
+- **[Utility Decorators](docs/decorators.md):** Easily measure function execution time (`timeIt`) and add retry logic (`retry`) to any function
+- **[Stream Sanitization Utilities](docs/sanitize.md):** Advanced tools for cleaning, decoding, and processing data streams
 </p>
 </details>
 
@@ -304,7 +306,8 @@ For more information, visit the [Inferno GitHub repository](https://github.com/H
 </p>
 </details>
 
-> [!NOTE] > **Hardware requirements for running models with Inferno:**
+> [!NOTE]  
+> **Hardware requirements for running models with Inferno:**
 >
 > - Around 2 GB of RAM for 1B models
 > - Around 4 GB of RAM for 3B models
@@ -313,150 +316,7 @@ For more information, visit the [Inferno GitHub repository](https://github.com/H
 > - 32 GB of RAM for 33B models
 > - GPU acceleration is recommended for better performance
 
-<details open>
-<summary><b>🔄 OpenAI-Compatible API Server</b></summary>
-<p>
-
-Webscout includes an OpenAI-compatible API server that allows you to use any supported provider with tools and applications designed for OpenAI's API.
-
-### Starting the API Server
-
-#### From Command Line (Recommended)
-
-```bash
-# Start with default settings (port 8000)
-webscout-server
-
-# Start with custom port
-webscout-server --port 8080
-
-# Start with API key authentication
-webscout-server --api-key "your-secret-key"
-
-# Start in no-auth mode using command line flag (no API key required)
-webscout-server --no-auth
-
-# Start in no-auth mode using environment variable
-$env:WEBSCOUT_NO_AUTH='true'; webscout-server
-
-# Specify a default provider
-webscout-server --default-provider "Claude"
-
-# Run in debug mode
-webscout-server --debug
-
-# Get help for all options (includes authentication options)
-webscout-server --help
-```
-
-#### Alternative Methods
-
-```bash
-# Using UV (no installation required)
-uv run --extra api webscout-server
-
-# Using Python module
-python -m webscout.auth.server
-```
-
-#### Environment Variables
-
-Webscout server supports configuration through environment variables:
-
-```bash
-# Start server in no-auth mode (no API key required)
-$env:WEBSCOUT_NO_AUTH='true'; webscout-server
-
-# Disable rate limiting
-$env:WEBSCOUT_NO_RATE_LIMIT='true'; webscout-server
-
-# Start with custom port using environment variable
-$env:WEBSCOUT_PORT='7860'; webscout-server
-```
-
-For a complete list of supported environment variables and Docker deployment options, see [DOCKER.md](DOCKER.md).
-
-#### From Python Code
-
-> **Recommended:**  
-> Use `start_server` from `webscout.client` for the simplest programmatic startup.  
-> For advanced control (custom host, debug, etc.), use `run_api`.
-
-```python
-# Method 1: Using the helper function (recommended)
-from webscout.client import start_server
-
-# Start with default settings
-start_server()
-
-# Start with custom settings
-start_server(port=8080, api_key="your-secret-key", default_provider="Claude")
-
-# Start in no-auth mode (no API key required)
-start_server(no_auth=True)
-
-# Method 2: Advanced usage with run_api
-from webscout.client import run_api
-
-run_api(
-    host="0.0.0.0",
-    debug=True
-)
-```
-
-### Using the API
-
-Once the server is running, you can use it with any OpenAI client library or tool:
-
-```python
-# Using the OpenAI Python client
-from openai import OpenAI
-
-client = OpenAI(
-    api_key="your-secret-key",  # Only needed if you set an API key
-    base_url="http://localhost:8000/v1"  # Point to your local server
-)
-
-# Chat completion
-response = client.chat.completions.create(
-    model="gpt-4",  # This can be any model name registered with Webscout
-    messages=[
-        {"role": "system", "content": "You are a helpful assistant."},
-        {"role": "user", "content": "Hello, how are you?"}
-    ]
-)
-
-print(response.choices[0].message.content)
-```
-
-### Using with cURL
-
-```bash
-# Basic chat completion request
-curl http://localhost:8000/v1/chat/completions \
-  -H "Content-Type: application/json" \
-  -H "Authorization: Bearer your-secret-key" \
-  -d '{
-    "model": "gpt-4",
-    "messages": [
-      {"role": "system", "content": "You are a helpful assistant."},
-      {"role": "user", "content": "Hello, how are you?"}
-    ]
-  }'
-
-# List available models
-curl http://localhost:8000/v1/models \
-  -H "Authorization: Bearer your-secret-key"
-```
-
-### Available Endpoints
-
-- `GET /v1/models` - List all available models
-- `GET /v1/models/{model_name}` - Get information about a specific model
-- `POST /v1/chat/completions` - Create a chat completion
-
-</p>
-</details>
+For detailed information about the OpenAI-compatible API server, including setup, configuration, and usage examples, see the [OpenAI API Server Documentation](docs/openai-api-server.md).
 
 <hr/>
 

{webscout-8.3.4 → webscout-8.3.6}/pyproject.toml

@@ -52,7 +52,6 @@ dependencies = [
     "mistune",
     "curl_cffi",
     "nest-asyncio",
-    "websocket-client",
     "colorama",
     "rich",
     "markdownify",
@@ -98,6 +97,8 @@ api = [
     "tiktoken",  # Added tiktoken for token counting support
     "motor",  # MongoDB async driver for enhanced authentication
     "jinja2",  # Template engine for custom Swagger UI
+    "supabase",  # Supabase client for database operations
+    "websockets>=11.0",  # Ensure websockets.asyncio module is available for Supabase realtime
 ]
 
 [tool.setuptools]

webscout-8.3.6/webscout/AIutel.py

@@ -0,0 +1,58 @@
+from .sanitize import * # noqa: E402,F401
+from .conversation import Conversation  # noqa: E402,F401
+from .Extra.autocoder import AutoCoder  # noqa: E402,F401
+from .optimizers import Optimizers  # noqa: E402,F401
+from .prompt_manager import AwesomePrompts  # noqa: E402,F401
+
+# --- Utility Decorators ---
+from typing import Callable
+import time
+import functools
+
+def timeIt(func: Callable):
+    """
+    Decorator to measure execution time of a function (sync or async).
+    Prints: - Execution time for '{func.__name__}' : {elapsed:.6f} Seconds.  
+    """
+    import asyncio
+    GREEN_BOLD = "\033[1;92m"
+    RESET = "\033[0m"
+    @functools.wraps(func)
+    def sync_wrapper(*args, **kwargs):
+        start_time = time.time()
+        result = func(*args, **kwargs)
+        end_time = time.time()
+        print(f"{GREEN_BOLD}- Execution time for '{func.__name__}' : {end_time - start_time:.6f} Seconds.  {RESET}\n")
+        return result
+
+    @functools.wraps(func)
+    async def async_wrapper(*args, **kwargs):
+        start_time = time.time()
+        result = await func(*args, **kwargs)
+        end_time = time.time()
+        print(f"{GREEN_BOLD}- Execution time for '{func.__name__}' : {end_time - start_time:.6f} Seconds.  {RESET}\n")
+        return result
+
+    if asyncio.iscoroutinefunction(func):
+        return async_wrapper
+    else:
+        return sync_wrapper
+
+def retry(retries: int = 3, delay: float = 1) -> Callable:
+    """
+    Decorator to retry a function on exception.
+    """
+    def decorator(func: Callable):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            last_exc = None
+            for attempt in range(retries):
+                try:
+                    return func(*args, **kwargs)
+                except Exception as exc:
+                    last_exc = exc
+                    print(f"Attempt {attempt + 1} failed: {exc}. Retrying in {delay} seconds...")
+                    time.sleep(delay)
+            raise last_exc
+        return wrapper
+    return decorator

{webscout-8.3.4 → webscout-8.3.6}/webscout/Bard.py

@@ -8,24 +8,30 @@ import os
 import random
 import re
 import string
+from datetime import datetime
 from enum import Enum
 from pathlib import Path
-from datetime import datetime
-from typing import Dict, List, Tuple, Union, Optional
+from typing import Dict, List, Optional, Tuple, Union
 
 # Use curl_cffi for requests
+# Import trio before curl_cffi to prevent eventlet socket monkey-patching conflicts
+# See: https://github.com/python-trio/trio/issues/3015
+try:
+    import trio  # noqa: F401
+except ImportError:
+    pass  # trio is optional, ignore if not available
 from curl_cffi import CurlError
 from curl_cffi.requests import AsyncSession
-# Import common request exceptions (curl_cffi often wraps these)
-from requests.exceptions import RequestException, Timeout, HTTPError
 
 # For image models using validation. Adjust based on organization internal pydantic.
 # Updated import for Pydantic V2
 from pydantic import BaseModel, field_validator
 
+# Import common request exceptions (curl_cffi often wraps these)
+from requests.exceptions import HTTPError, RequestException, Timeout
+
 # Rich is retained for logging within image methods.
 from rich.console import Console
-from rich.markdown import Markdown
 
 console = Console()
 
@@ -875,7 +881,7 @@ class Image(BaseModel):
         # Generate filename from URL if not provided
         if not filename:
             try:
-                from urllib.parse import urlparse, unquote
+                from urllib.parse import unquote, urlparse
                 parsed_url = urlparse(self.url)
                 base_filename = os.path.basename(unquote(parsed_url.path))
                 # Remove invalid characters for filenames