webscout 8.2.8__py3-none-any.whl → 8.2.9__py3-none-any.whl

webscout/client.py

@@ -0,0 +1,70 @@
+"""
+Unified client import for OpenAI-compatible providers and server utilities.
+
+This module provides a unified import interface for all OpenAI-compatible providers and exposes
+helper functions to start the OpenAI-compatible API server programmatically.
+
+Usage:
+    from webscout.client import FreeAIChat, AI4Chat, ExaChat, MultiChatAI, TwoAI, SciraChat, ChatSandbox, C4AI, Groq, TypeGPT, LLMChat, Cleeai, DeepInfra, BlackboxAI, Cloudflare, Netwrck, OIVSCode, Venice, Writecream, Wisecat, Yep, X0GPT, Sonus, Toolbaz, TextPollinations, StandardInput, Opkfc, Flowith, ExaAI, FreeGemini, GeminiAPI, Gemini, GithubChat, GizAI, Glider, HeckAI, HuggingFaceChat, Hunyuan, Jadve, Julius, Koala, LearnFast, LearnFastAI, NEMOTRON, MCPCore, PydanticImports, TeachAnything, UncovrAI, API, Base
+    client = FreeAIChat()
+    response = client.chat.completions.create(...)
+
+    # To start the server programmatically:
+    from webscout.client import start_server
+    start_server()
+
+    # For advanced server control:
+    from webscout.client import run_api
+    run_api(host="0.0.0.0", port=8000, debug=True)
+
+    # Instantly start the API server from the command line:
+    #   python -m webscout.client
+    # or, if installed as a script:
+    #   webscout-api
+
+Exports:
+    - All OpenAI-compatible provider classes
+    - start_server (function): Start the OpenAI-compatible API server with default or custom settings.
+    - run_api (function): Advanced server startup with full control over host, port, and other options.
+"""
+
+from webscout.Provider.OPENAI import *
+from webscout.Provider.OPENAI.api import start_server, run_api
+
+# ---
+# API Documentation
+#
+# start_server
+# -------------
+# def start_server(port: int = 8000, api_key: str = None, default_provider: str = None, base_url: str = None):
+#     """
+#     Start the OpenAI-compatible API server with optional configuration.
+#
+#     Parameters:
+#         port (int, optional): The port to run the server on. Defaults to 8000.
+#         api_key (str, optional): API key for authentication. If None, authentication is disabled.
+#         default_provider (str, optional): The default provider to use. If None, uses the package default.
+#         base_url (str, optional): Base URL prefix for the API (e.g., '/api/v1'). If None, no prefix is used.
+#
+#     Returns:
+#         None
+#     """
+#
+# run_api
+# -------
+# def run_api(host: str = '0.0.0.0', port: int = None, api_key: str = None, default_provider: str = None, base_url: str = None, debug: bool = False, show_available_providers: bool = True):
+#     """
+#     Advanced server startup for the OpenAI-compatible API server.
+#
+#     Parameters:
+#         host (str, optional): Host address to bind the server. Defaults to '0.0.0.0'.
+#         port (int, optional): Port to run the server on. Defaults to 8000 if not specified.
+#         api_key (str, optional): API key for authentication. If None, authentication is disabled.
+#         default_provider (str, optional): The default provider to use. If None, uses the package default.
+#         base_url (str, optional): Base URL prefix for the API (e.g., '/api/v1'). If None, no prefix is used.
+#         debug (bool, optional): Run the server in debug mode with auto-reload. Defaults to False.
+#         show_available_providers (bool, optional): Print available providers on startup. Defaults to True.
+#
+#     Returns:
+#         None
+#     """

webscout/litprinter/__init__.py

@@ -1,59 +1,59 @@
-"""
->>> from litprinter import litprint
->>> from litprinter import lit
->>> from litprinter import install, uninstall
->>>
->>> litprint("Hello, world!")
-LIT -> [__main__.py:1] in () >>> Hello, world!
->>>
->>> def my_function():
-...    lit(1, 2, 3)
->>> my_function()
-LIT -> [__main__.py:4] in my_function() >>> 1, 2, 3
->>> install()
->>> ic("This is now the builtins.ic()")
-LIT -> [__main__.py:7] in () >>> This is now the builtins.ic()
->>> uninstall()
-
-This module provides enhanced print and logging functionalities for Python,
-allowing developers to debug their code with style and precision. It
-includes the litprint and lit functions for debugging, log for logging, and
-install/uninstall functions for integration into the builtins module.
-It also handles colorizing output and provides different styles and customizable
-options.
-
-LITPRINTER is inspired by the icecream package and provides similar functionality
-with additional features:
-- Variable inspection with expression display
-- Return value handling for inline usage
-- Support for custom formatters for specific data types
-- Execution context tracking
-- Rich-like colorized output with multiple themes (JARVIS, RICH, MODERN, NEON, CYBERPUNK)
-- Better JSON formatting with indent=2 by default
-- Advanced pretty printing for complex data structures with smart truncation
-- Clickable file paths in supported terminals and editors (VSCode compatible)
-- Enhanced visual formatting with better spacing and separators
-- Special formatters for common types (Exception, bytes, set, frozenset, etc.)
-- Smart object introspection for custom classes
-- Logging capabilities with timestamp and log levels
-"""
-
-# Try to import from the standalone litprinter package first
-# If it's not installed
-try:
-    import litprinter
-    # If standalone package is found, re-export all its components
-    from litprinter import litprint, lit, log, ic, install, uninstall
-    from litprinter import LITPrintDebugger, argumentToString
-    from litprinter import JARVIS, RICH, MODERN, NEON, CYBERPUNK, create_custom_style
-    from litprinter import traceback   
-    # For compatibility with icecream
-    enable = litprinter.enable
-    disable = litprinter.disable
-    
-except ImportError:
-    # Raise a more informative error when litprinter is not installed
-    raise ImportError(
-        "The 'litprinter' package is required but not installed. "
-        "Please install it using: pip install litprinter"
+"""
+>>> from litprinter import litprint
+>>> from litprinter import lit
+>>> from litprinter import install, uninstall
+>>>
+>>> litprint("Hello, world!")
+LIT -> [__main__.py:1] in () >>> Hello, world!
+>>>
+>>> def my_function():
+...    lit(1, 2, 3)
+>>> my_function()
+LIT -> [__main__.py:4] in my_function() >>> 1, 2, 3
+>>> install()
+>>> ic("This is now the builtins.ic()")
+LIT -> [__main__.py:7] in () >>> This is now the builtins.ic()
+>>> uninstall()
+
+This module provides enhanced print and logging functionalities for Python,
+allowing developers to debug their code with style and precision. It
+includes the litprint and lit functions for debugging, log for logging, and
+install/uninstall functions for integration into the builtins module.
+It also handles colorizing output and provides different styles and customizable
+options.
+
+LITPRINTER is inspired by the icecream package and provides similar functionality
+with additional features:
+- Variable inspection with expression display
+- Return value handling for inline usage
+- Support for custom formatters for specific data types
+- Execution context tracking
+- Rich-like colorized output with multiple themes (JARVIS, RICH, MODERN, NEON, CYBERPUNK)
+- Better JSON formatting with indent=2 by default
+- Advanced pretty printing for complex data structures with smart truncation
+- Clickable file paths in supported terminals and editors (VSCode compatible)
+- Enhanced visual formatting with better spacing and separators
+- Special formatters for common types (Exception, bytes, set, frozenset, etc.)
+- Smart object introspection for custom classes
+- Logging capabilities with timestamp and log levels
+"""
+
+# Try to import from the standalone litprinter package first
+# If it's not installed
+try:
+    import litprinter
+    # If standalone package is found, re-export all its components
+    from litprinter import litprint, lit, log, ic, install, uninstall
+    from litprinter import LITPrintDebugger, argumentToString
+    from litprinter import JARVIS, RICH, MODERN, NEON, CYBERPUNK, create_custom_style
+    from litprinter import traceback   
+    # For compatibility with icecream
+    enable = litprinter.enable
+    disable = litprinter.disable
+    
+except ImportError:
+    # Raise a more informative error when litprinter is not installed
+    raise ImportError(
+        "The 'litprinter' package is required but not installed. "
+        "Please install it using: pip install litprinter"
     ) from None