webscout 8.2.7__tar.gz → 8.2.9__tar.gz

webscout-8.2.9/LEGAL_NOTICE.md

@@ -0,0 +1,152 @@
+# Legal Notice
+
+> [!IMPORTANT]
+> This repository is **not associated with or endorsed** by the providers of the APIs contained herein. This project is intended **for educational purposes only**. It is a personal project aimed at learning and exploration.
+
+## Affiliation Disclaimer
+
+This repository is not associated with or endorsed by any of the API providers mentioned herein, including but not limited to:
+
+- DuckDuckGo
+- Google
+- Meta
+- OpenAI
+- Anthropic
+- Cohere
+- Perplexity
+- Yep.com
+- HuggingFace
+- And others
+
+All trademarks, API services, and other intellectual property referenced are the property of their respective owners. No claim of ownership or affiliation is made by this project.
+
+Owners of any included sites or services may contact the maintainers to improve their security or request the removal of their content from this repository.
+
+---
+
+## License
+
+This repository is licensed under the Apache License, Version 2.0 with additional terms specific to Webscout's API usage and third-party services.
+
+> 📄 The full text of this license is available in the [LICENSE.md](./LICENSE.md) file.
+
+---
+
+## Liability Limitation
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, consequential, or exemplary damages of any character arising as a result of this License or out of the use or inability to use the Work.
+
+---
+
+## No Warranties
+
+> [!WARNING]
+> The Work is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of:
+> - TITLE
+> - NON-INFRINGEMENT
+> - MERCHANTABILITY
+> - FITNESS FOR A PARTICULAR PURPOSE
+
+You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+---
+
+## User Responsibility
+
+> [!IMPORTANT]
+> Users assume all risks associated with the use of this repository. They are responsible for ensuring their use complies with all terms of service for the APIs accessed through this toolkit and must obtain any necessary permissions or licenses for third-party services.
+
+---
+
+## Legal Compliance
+
+Users are responsible for ensuring that their use of the repository and its contents complies with all applicable:
+
+- Local laws and regulations
+- State laws and regulations
+- National laws and regulations
+- International laws and regulations
+
+Including but not limited to:
+* Privacy laws
+* Data protection regulations
+* Export control laws
+
+---
+
+## Redistribution Requirements
+
+When redistributing copies of the Work or Derivative Works thereof:
+
+1. You **must** give recipients a copy of the License
+2. You **must** cause any modified files to carry prominent notices stating that You changed the files
+3. You **must** retain all copyright, patent, trademark, and attribution notices from the Source form of the Work
+4. You **must** include any NOTICE file as part of its distribution
+
+---
+
+## Third-Party Services
+
+> [!NOTE]
+> When using the APIs and services accessed through this Work, you must:
+>
+> 1. Comply with all terms of service of the respective API providers
+> 2. Maintain appropriate attribution and licenses for third-party services
+> 3. Be responsible for obtaining any necessary permissions or licenses
+> 4. Not use the Work in any way that could damage or overload third-party services
+
+---
+
+## Trademarks
+
+This License does not grant permission to use trade names, trademarks, service marks, or product names of the contributors, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+---
+
+## Privacy Notice
+
+> [!NOTE]
+> Webscout may collect usage data and performance metrics. By using this repository, you acknowledge that:
+>
+> 1. Such data collection will comply with applicable privacy laws
+> 2. You must provide appropriate privacy notices to end users
+> 3. You must obtain necessary consents for data collection
+> 4. You must implement appropriate data security measures
+
+---
+
+## Contributions
+
+Unless explicitly stated otherwise, any Contribution intentionally submitted for inclusion in the Work shall be under the terms and conditions of this License, without any additional terms or conditions.
+
+**FOR CONTRIBUTORS**: By submitting content to this project, you agree to the terms outlined in this document.
+
+---
+
+## Export Compliance
+
+The Work and its use may be subject to export laws and regulations. Users agree to comply with all such laws and regulations that may apply to the Work after distribution.
+
+---
+
+## Severability
+
+If any provision of this notice is found to be unlawful, void, or unenforceable, that provision shall be deemed severable from this notice and shall not affect the validity and enforceability of the remaining provisions.
+
+---
+
+## Updates and Changes
+
+> [!NOTE]
+> The author reserves the right to modify, update, or remove any content, information, or features in this repository at any time without prior notice. Users are responsible for regularly reviewing the content and any changes made to this repository.
+
+---
+
+<details>
+<summary><strong>Document Version Information</strong></summary>
+
+- **Last Updated**: April 14, 2025
+- **Version**: 1.2
+- **Document Owner**: Webscout Team
+</details>
+

webscout-8.2.9/MANIFEST.in

@@ -0,0 +1,12 @@
+include LICENSE.md
+include README.md
+include LEGAL_NOTICE.md
+include changelog.md
+
+recursive-include webscout *
+
+# Exclude common unwanted files and directories
+recursive-exclude webscout __pycache__
+recursive-exclude webscout *.pyc
+recursive-exclude webscout *.pyo
+recursive-exclude webscout *.pyd

{webscout-8.2.7/webscout.egg-info → webscout-8.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webscout
-Version: 8.2.7
+Version: 8.2.9
 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
@@ -39,7 +39,6 @@ Requires-Dist: wheel
 Requires-Dist: pip
 Requires-Dist: nodriver
 Requires-Dist: mistune
-Requires-Dist: tenacity
 Requires-Dist: curl_cffi
 Requires-Dist: nest-asyncio
 Requires-Dist: websocket-client
@@ -49,7 +48,6 @@ Requires-Dist: markdownify
 Requires-Dist: requests
 Requires-Dist: google-generativeai
 Requires-Dist: lxml>=5.2.2
-Requires-Dist: termcolor
 Requires-Dist: orjson
 Requires-Dist: PyYAML
 Requires-Dist: ollama
@@ -59,14 +57,19 @@ Requires-Dist: cloudscraper
 Requires-Dist: html5lib
 Requires-Dist: aiofiles
 Requires-Dist: openai
-Requires-Dist: prompt-toolkit
-Requires-Dist: pyreqwest_impersonate
 Requires-Dist: gradio_client
 Requires-Dist: psutil
 Requires-Dist: aiohttp
+Requires-Dist: zstandard
 Provides-Extra: dev
 Requires-Dist: ruff>=0.1.6; extra == "dev"
 Requires-Dist: pytest>=7.4.2; extra == "dev"
+Provides-Extra: api
+Requires-Dist: fastapi; extra == "api"
+Requires-Dist: uvicorn[standard]; extra == "api"
+Requires-Dist: pydantic; extra == "api"
+Requires-Dist: python-multipart; extra == "api"
+Requires-Dist: tiktoken; extra == "api"
 Dynamic: license-file
 
 <div align="center">
@@ -88,6 +91,7 @@ Dynamic: license-file
     <a href="https://pepy.tech/project/webscout"><img src="https://static.pepy.tech/badge/webscout/month?style=flat-square" alt="Monthly Downloads"></a>
     <a href="https://pepy.tech/project/webscout"><img src="https://static.pepy.tech/badge/webscout?style=flat-square" alt="Total Downloads"></a>
     <a href="#"><img src="https://img.shields.io/pypi/pyversions/webscout?style=flat-square&logo=python" alt="Python Version"></a>
+    <a href="https://deepwiki.com/OEvortex/Webscout"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
   </p>
 </div>
 
@@ -98,6 +102,7 @@ Dynamic: license-file
 - [🌟 Key Features](#-features)
 - [⚙️ Installation](#️-installation)
 - [🖥️ Command Line Interface](#️-command-line-interface)
+- [🔄 OpenAI-Compatible API Server](#-openai-compatible-api-server)
 - [🔍 Search Engines](#-search-engines)
 - [🦆 DuckDuckGo Search](#-duckduckgo-search-with-webs-and-asyncwebs)
 - [💻 WEBS API Reference](#-webs-api-reference)
@@ -115,7 +120,7 @@ Dynamic: license-file
 > - **OpenAI Compatibility:** Use providers with OpenAI-compatible interfaces
 > - **Local LLM Compatibility:** Run local models with [Inferno](https://github.com/HelpingAI/inferno), an OpenAI-compatible server (now a standalone package)
 >
-> Choose the approach that best fits your needs! For OpenAI compatibility, check the [OpenAI Providers README](webscout/Provider/OPENAI/README.md).
+> Choose the approach that best fits your needs! For OpenAI compatibility, check the [OpenAI Providers README](webscout/Provider/OPENAI/README.md) or see the [OpenAI-Compatible API Server](#-openai-compatible-api-server) section below.
 
 > [!NOTE]
 > Webscout supports over 90 AI providers including: LLAMA, C4ai, Venice, Copilot, HuggingFaceChat, PerplexityLabs, DeepSeek, WiseCat, GROQ, OPENAI, GEMINI, DeepInfra, Meta, YEPCHAT, TypeGPT, ChatGPTClone, ExaAI, Claude, Anthropic, Cloudflare, AI21, Cerebras, and many more. All providers follow similar usage patterns with consistent interfaces.
@@ -167,7 +172,7 @@ Dynamic: license-file
 * **[GitAPI](webscout/Extra/GitToolkit/gitapi):** Powerful GitHub data extraction toolkit without authentication requirements for public data
 * **[SwiftCLI](webscout/swiftcli/Readme.md):** A powerful and elegant CLI framework for beautiful command-line interfaces
 * **[LitPrinter](webscout/litprinter/Readme.md):** Styled console output with rich formatting and colors
-* **[LitLogger](webscout/litlogger/Readme.md):** Simplified logging with customizable formats and color schemes
+* **[LitLogger](webscout/litlogger/README.md):** Simplified logging with customizable formats and color schemes
 * **[LitAgent](webscout/litagent/Readme.md):** Modern user agent generator that keeps your requests undetectable
 * **[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`)
@@ -188,46 +193,154 @@ Dynamic: license-file
 
 ## ⚙️ Installation
 
-Install Webscout using pip:
+Webscout supports multiple installation methods to fit your workflow:
+
+### 📦 Standard Installation
 
 ```bash
+# Install from PyPI
 pip install -U webscout
+
+# Install with API server dependencies
+pip install -U "webscout[api]"
+
+# Install with development dependencies
+pip install -U "webscout[dev]"
+```
+
+### ⚡ UV Package Manager (Recommended)
+
+[UV](https://github.com/astral-sh/uv) is a fast Python package manager. Webscout has full UV support:
+
+```bash
+# Install UV first (if not already installed)
+pip install uv
+
+# Install Webscout with UV
+uv add webscout
+
+# Install with API dependencies
+uv add "webscout[api]"
+
+# Run Webscout directly with UV (no installation needed)
+uv run webscout --help
+
+# Run with API dependencies
+uv run --extra api webscout-server
+
+# Install as a UV tool for global access
+uv tool install webscout
+
+# Use UV tool commands
+webscout --help
+webscout-server --help
+```
+
+### 🔧 Development Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/OEvortex/Webscout.git
+cd Webscout
+
+# Install in development mode with UV
+uv sync --extra dev --extra api
+
+# Or with pip
+pip install -e ".[dev,api]"
+```
+
+### 🐳 Docker Installation
+
+```bash
+# Pull and run the Docker image
+docker pull oevortex/webscout:latest
+docker run -it oevortex/webscout:latest
+```
+
+### 📱 Quick Start Commands
+
+After installation, you can immediately start using Webscout:
+
+```bash
+# Check version
+webscout version
+
+# Search the web
+webscout text -k "python programming"
+
+# Start API server
+webscout-server
+
+# Get help
+webscout --help
 ```
-</div>
 
 <hr/>
 
 ## 🖥️ Command Line Interface
 
-Webscout provides a powerful command-line interface for quick access to its features:
+Webscout provides a powerful command-line interface for quick access to its features. You can use it in multiple ways:
+
+### 🚀 Direct Commands (Recommended)
+
+After installing with `uv tool install webscout` or `pip install webscout`:
 
 ```bash
+# Get help
+webscout --help
+
+# Start API server
+webscout-server
+```
+
+### 🔧 UV Run Commands (No Installation Required)
+
+```bash
+# Run directly with UV (downloads and runs automatically)
+uv run webscout --help
+uv run --extra api webscout-server
+```
+
+### 📦 Python Module Commands
+
+```bash
+# Traditional Python module execution
 python -m webscout --help
+python -m webscout.client  # Start API server
 ```
 
 <details open>
-<summary><b>Web Search Commands</b></summary>
+<summary><b>🔍 Web Search Commands</b></summary>
 <p>
 
-| Command | Description |
-|---------|-------------|
-| `python -m webscout answers -k "query"` | Perform an answers search |
-| `python -m webscout chat` | Start an interactive AI chat session |
-| `python -m webscout images -k "query"` | Search for images |
-| `python -m webscout maps -k "query"` | Perform a maps search |
-| `python -m webscout news -k "query"` | Search for news articles |
-| `python -m webscout suggestions -k "query"` | Get search suggestions |
-| `python -m webscout text -k "query"` | Perform a text search |
-| `python -m webscout translate -k "text"` | Translate text |
-| `python -m webscout version` | Display the current version |
-| `python -m webscout videos -k "query"` | Search for videos |
-| `python -m webscout weather -l "location"` | Get weather information |
-| `python -m webscout google_text -k "query"` | Perform a text search using Google |
-| `python -m webscout google_news -k "query"` | Search for news using Google |
-| `python -m webscout google_suggestions -q "query"` | Get search suggestions from Google |
-| `python -m webscout yep_text -k "query"` | Perform a text search using Yep |
-| `python -m webscout yep_images -k "query"` | Search for images using Yep |
-| `python -m webscout yep_suggestions -q "query"` | Get search suggestions from Yep |
+| Command | Description | Example |
+|---------|-------------|---------|
+| `webscout text -k "query"` | Perform a text search | `webscout text -k "python programming"` |
+| `webscout answers -k "query"` | Get instant answers | `webscout answers -k "what is AI"` |
+| `webscout images -k "query"` | Search for images | `webscout images -k "nature photography"` |
+| `webscout videos -k "query"` | Search for videos | `webscout videos -k "python tutorials"` |
+| `webscout news -k "query"` | Search for news articles | `webscout news -k "technology trends"` |
+| `webscout maps -k "query"` | Perform a maps search | `webscout maps -k "restaurants near me"` |
+| `webscout translate -k "text"` | Translate text | `webscout translate -k "hello world"` |
+| `webscout suggestions -k "query"` | Get search suggestions | `webscout suggestions -k "how to"` |
+| `webscout weather -l "location"` | Get weather information | `webscout weather -l "New York"` |
+| `webscout version` | Display the current version | `webscout version` |
+
+**Google Search Commands:**
+| Command | Description | Example |
+|---------|-------------|---------|
+| `webscout google_text -k "query"` | Google text search | `webscout google_text -k "machine learning"` |
+| `webscout google_news -k "query"` | Google news search | `webscout google_news -k "AI breakthrough"` |
+| `webscout google_suggestions -q "query"` | Google suggestions | `webscout google_suggestions -q "python"` |
+
+**Yep Search Commands:**
+| Command | Description | Example |
+|---------|-------------|---------|
+| `webscout yep_text -k "query"` | Yep text search | `webscout yep_text -k "web development"` |
+| `webscout yep_images -k "query"` | Yep image search | `webscout yep_images -k "landscapes"` |
+| `webscout yep_suggestions -q "query"` | Yep suggestions | `webscout yep_suggestions -q "javascript"` |
+
 </p>
 </details>
 
@@ -269,6 +382,124 @@ 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"
+
+# Specify a default provider
+webscout-server --default-provider "Claude"
+
+# Run in debug mode
+webscout-server --debug
+
+# Get help for all options
+webscout-server --help
+```
+
+#### Alternative Methods
+
+```bash
+# Using UV (no installation required)
+uv run --extra api webscout-server
+
+# Using Python module
+python -m webscout.client
+
+# Legacy method (still supported)
+python -m webscout.Provider.OPENAI.api
+```
+
+#### From Python Code
+
+```python
+# Method 1: Using the helper function
+from webscout.client import start_server  # <--- Now recommended
+
+# Start with default settings
+start_server()
+
+# Start with custom settings
+start_server(port=8080, api_key="your-secret-key", default_provider="Claude")
+
+# Method 2: Using the run_api function for more control
+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>
+
 <hr/>
 
 ## 🔍 Search Engines
@@ -605,30 +836,12 @@ Webscout offers a comprehensive collection of AI chat providers, giving you acce
 | `DeepInfra` | Various open models | Multiple model options |
 | `Cohere` | Cohere's language models | Command models |
 | `PerplexityLabs` | Perplexity AI | Web search integration |
-| `Anthropic` | Claude models | Long context windows |
 | `YEPCHAT` | Yep.com's AI | Streaming responses |
 | `ChatGPTClone` | ChatGPT-like interface | Multiple model options |
-| `TypeGPT` | TypeChat models | Code generation focus |
+| `TypeGPT` | TypeChat models | Multiple model options |
 
 </div>
 
-<details>
-<summary><b>Example: Using Duckchat</b></summary>
-<p>
-
-```python
-from webscout import WEBS
-
-# Initialize and use Duckchat
-with WEBS() as webs:
-    response = webs.chat(
-        "Explain quantum computing in simple terms",
-        model='gpt-4o-mini'  # Options: mixtral-8x7b, llama-3.1-70b, claude-3-haiku, etc.
-    )
-    print(response)
-```
-</p>
-</details>
 
 <details>
 <summary><b>Example: Using Meta AI</b></summary>
@@ -740,41 +953,7 @@ print(response)
 </p>
 </details>
 
-<hr/>
-
-## 👨‍💻 Advanced AI Interfaces
-
-<details open>
-<summary><b>Direct Model Access with LLM and VLM</b></summary>
-<p>
-
-Webscout provides direct interfaces to language and vision-language models through the `LLM` and `VLM` classes.
-
-```python
-from webscout.LLM import LLM, VLM
 
-# Text-only model interaction
-llm = LLM("meta-llama/Meta-Llama-3-70B-Instruct")
-response = llm.chat([
-    {"role": "user", "content": "Explain the concept of neural networks"}
-])
-print(response)
-
-# Vision-language model interaction
-vlm = VLM("cogvlm-grounding-generalist")
-response = vlm.chat([
-    {
-        "role": "user",
-        "content": [
-            {"type": "image", "image_url": "path/to/image.jpg"},
-            {"type": "text", "text": "Describe what you see in this image"}
-        ]
-    }
-])
-print(response)
-```
-</p>
-</details>
 
 <details open>
 <summary><b>GGUF Model Conversion</b></summary>