<div align="center"> <a href="https://github.com/OEvortex/Webscout"> <img src="https://img.shields.io/badge/WebScout-Ultimate%20Toolkit-blue?style=for-the-badge&logo=python&logoColor=white" alt="WebScout Logo"> </a> <h1>Webscout</h1> <p><strong>Your All-in-One Python Toolkit for Web Search, AI Interaction, Digital Utilities, and More</strong></p> <p> Access diverse search engines, cutting-edge AI models, temporary communication tools, media utilities, developer helpers, and powerful CLI interfaces – all through one unified library. </p>  <p> <a href="https://pypi.org/project/webscout/"><img src="https://img.shields.io/pypi/v/webscout.svg?style=flat-square&logo=pypi&label=PyPI" alt="PyPI Version"></a> <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> <hr/>

📋 Table of Contents

<hr/>

[!IMPORTANT] Webscout supports three types of compatibility:

Native Compatibility: Webscout's own native API for maximum flexibility

OpenAI Compatibility: Use providers with OpenAI-compatible interfaces

Local LLM Compatibility: Run local models with OpenAI-compatible servers

Choose the approach that best fits your needs! For OpenAI compatibility, check the OpenAI Providers README or see the OpenAI-Compatible API Server section below.

[!NOTE] Webscout supports over 90 AI providers including: LLAMA, C4ai, 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.

🚀 Features

<details open> <summary><b>Search & AI</b></summary> <p>

Comprehensive Search: Access multiple search engines including DuckDuckGo, Yep, Bing, Brave, Yahoo, Yandex, Mojeek, and Wikipedia for diverse search results (Search Documentation)
AI Powerhouse: Access and interact with various AI models through three compatibility options:
- Native API: Use Webscout's native interfaces for providers like OpenAI, Cohere, Gemini, and many more
- OpenAI-Compatible Providers: Seamlessly integrate with various AI providers using standardized OpenAI-compatible interfaces
- Local LLMs: Run local models with OpenAI-compatible servers (see Inferno documentation)
AI Search: AI-powered search engines with advanced capabilities
OpenAI-Compatible API Server: Run a local API server that serves any Webscout provider through OpenAI-compatible endpoints
Python Client API: Use Webscout providers directly in Python with OpenAI-compatible format

</p> </details> <details open> <summary><b>Media & Content Tools</b></summary> <p>

YouTube Toolkit: Advanced YouTube video and transcript management with multi-language support
Text-to-Speech (TTS): Convert text into natural-sounding speech using multiple AI-powered providers
Text-to-Image: Generate high-quality images using a wide range of AI art providers
Weather Tools: Retrieve detailed weather information for any location

</p> </details> <details open> <summary><b>Developer Tools</b></summary> <p>

GitAPI: Powerful GitHub data extraction toolkit without authentication requirements for public data
SwiftCLI: A powerful and elegant CLI framework for beautiful command-line interfaces
LitPrinter: Styled console output with rich formatting and colors
LitAgent: Modern user agent generator that keeps your requests undetectable
Scout: Advanced web parsing and crawling library with intelligent HTML/XML parsing
GGUF Conversion: Convert and quantize Hugging Face models to GGUF format
Utility Decorators: Easily measure function execution time (timeIt) and add retry logic (retry) to any function
Stream Sanitization Utilities: Advanced tools for cleaning, decoding, and processing data streams
Command Line Interface: Comprehensive CLI for all search engines and utilities

</p> </details> <details open> <summary><b>Privacy & Utilities</b></summary> <p>

Tempmail & Temp Number: Generate temporary email addresses and phone numbers
Awesome Prompts Manager: Curated collection of system prompts for specialized AI personas with comprehensive management capabilities

</p> </details> <hr/>

⚙️ Installation

Webscout supports multiple installation methods to fit your workflow:

📦 Standard Installation

# 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 is a fast Python package manager. Webscout has full UV support:

# 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 webscout --extra api webscout-server

# Install as a UV tool for global access
uv tool install webscout

# Use UV tool commands
webscout --help
webscout-server

🔧 Development Installation

# 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]"

#  Or with uv pip
uv pip install -e ".[dev,api]"

🐳 Docker Installation

# 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:

# Check version
webscout version

# Search the web
webscout text -k "python programming"

# Start API server
webscout-server

# Get help
webscout --help

<hr/>

🖥️ Command Line Interface

Webscout provides a comprehensive command-line interface with support for multiple search engines and utilities. You can use it in multiple ways:

🚀 Direct Commands (Recommended)

After installing with uv tool install webscout or pip install webscout:

# Get help and list all commands
webscout --help

# Show version
webscout version

# Start API server
webscout-server

# Web search commands
webscout text -k "python programming"              # DuckDuckGo text search
webscout images -k "mountain landscape"            # DuckDuckGo image search
webscout news -k "AI breakthrough" -t w            # News from last week
webscout weather -l "New York"                     # Weather information
webscout translate -k "Hello" -to es               # Translation

# Alternative search engines
webscout yahoo_text -k "machine learning" -r us    # Yahoo search
webscout bing_text -k "climate change"             # Bing search
webscout yep_text -k "latest news"                 # Yep search

# Search with advanced options
webscout images

Webscout

Install / Use

README