webscout 8.2.4__tar.gz → 8.2.5__tar.gz

{webscout-8.2.4 → webscout-8.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webscout
-Version: 8.2.4
+Version: 8.2.5
 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: OEvortex
 Author-email: helpingai5@gmail.com
@@ -68,15 +68,6 @@ Requires-Dist: aiohttp
 Provides-Extra: dev
 Requires-Dist: ruff>=0.1.6; extra == "dev"
 Requires-Dist: pytest>=7.4.2; extra == "dev"
-Provides-Extra: local
-Requires-Dist: llama-cpp-python; extra == "local"
-Requires-Dist: fastapi; extra == "local"
-Requires-Dist: uvicorn; extra == "local"
-Requires-Dist: rich; extra == "local"
-Requires-Dist: typer; extra == "local"
-Requires-Dist: huggingface_hub; extra == "local"
-Requires-Dist: pydantic; extra == "local"
-Requires-Dist: requests; extra == "local"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -113,11 +104,29 @@ Dynamic: summary
   </p>
 </div>
 
+<hr/>
+
+## 📋 Table of Contents
+
+- [🌟 Key Features](#-features)
+- [⚙️ Installation](#️-installation)
+- [🖥️ Command Line Interface](#️-command-line-interface)
+- [🔍 Search Engines](#-search-engines)
+- [🦆 DuckDuckGo Search](#-duckduckgo-search-with-webs-and-asyncwebs)
+- [💻 WEBS API Reference](#-webs-api-reference)
+- [🤖 AI Models and Voices](#-ai-models-and-voices)
+- [💬 AI Chat Providers](#-ai-chat-providers)
+- [👨‍💻 Advanced AI Interfaces](#-advanced-ai-interfaces)
+- [🤝 Contributing](#-contributing)
+- [🙏 Acknowledgments](#-acknowledgments)
+
+<hr/>
+
 > [!IMPORTANT]
-> Webscout supports three types of compatibility:
+> **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 [Inferno](webscout/Local/README.md), an OpenAI-compatible server
+> - **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).
 
@@ -136,36 +145,59 @@ Dynamic: summary
   </p>
 </div>
 
+<hr/>
 
 ## 🚀 Features
 
-### Search & AI
+<details open>
+<summary><b>Search & AI</b></summary>
+<p>
+
 * **Comprehensive Search:** Leverage Google, DuckDuckGo, and Yep for diverse search results
 * **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](webscout/Provider/OPENAI/README.md):** Seamlessly integrate with various AI providers using standardized OpenAI-compatible interfaces
-  * **[Local LLMs with Inferno](webscout/Local/README.md):** Run local models with an OpenAI-compatible server
+  * **[Local LLMs with Inferno](https://github.com/HelpingAI/inferno):** Run local models with an OpenAI-compatible server (now available as a standalone package)
 * **[AI Search](webscout/Provider/AISEARCH/README.md):** AI-powered search engines with advanced capabilities
+</p>
+</details>
+
+<details open>
+<summary><b>Media & Content Tools</b></summary>
+<p>
 
-### Media & Content Tools
 * **[YouTube Toolkit](webscout/Extra/YTToolkit/README.md):** Advanced YouTube video and transcript management with multi-language support
 * **[Text-to-Speech (TTS)](webscout/Provider/TTS/README.md):** Convert text into natural-sounding speech using multiple AI-powered providers
 * **[Text-to-Image](webscout/Provider/TTI/README.md):** Generate high-quality images using a wide range of AI art providers
 * **[Weather Tools](webscout/Extra/weather.md):** Retrieve detailed weather information for any location
+</p>
+</details>
+
+<details open>
+<summary><b>Developer Tools</b></summary>
+<p>
 
-### Developer Tools
 * **[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
 * **[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](webscout/Local/README.md):** Run local LLMs with an OpenAI-compatible API and interactive CLI
-* **GGUF Conversion:** Convert and quantize Hugging Face models to GGUF format
+* **[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
+</p>
+</details>
+
+<details open>
+<summary><b>Privacy & Utilities</b></summary>
+<p>
 
-### Privacy & Utilities
 * **[Tempmail](webscout/Extra/tempmail/README.md) & Temp Number:** Generate temporary email addresses and phone numbers
 * **[Awesome Prompts](webscout/Extra/Act.md):** Curated collection of system prompts for specialized AI personas
+</p>
+</details>
+
+<hr/>
 
 ## ⚙️ Installation
 
@@ -174,6 +206,9 @@ Install Webscout using pip:
 ```bash
 pip install -U webscout
 ```
+</div>
+
+<hr/>
 
 ## 🖥️ Command Line Interface
 
@@ -183,7 +218,9 @@ Webscout provides a powerful command-line interface for quick access to its feat
 python -m webscout --help
 ```
 
-### Web Search Commands
+<details open>
+<summary><b>Web Search Commands</b></summary>
+<p>
 
 | Command | Description |
 |---------|-------------|
@@ -198,26 +235,46 @@ python -m webscout --help
 | `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 |
+</p>
+</details>
 
-### Inferno LLM Commands
+<details open>
+<summary><b>Inferno LLM Commands</b></summary>
+<p>
 
-Inferno provides commands for managing and using local LLMs:
+Inferno is now a standalone package. Install it separately with:
 
 ```bash
-python -m inferno --help
+pip install inferno-llm
+```
+
+After installation, you can use its CLI for managing and using local LLMs:
+
+```bash
+inferno --help
 ```
 
 | Command | Description |
 |---------|-------------|
-| `python -m inferno pull <model>` | Download a model from Hugging Face |
-| `python -m inferno list` | List downloaded models |
-| `python -m inferno serve <model>` | Start a model server with OpenAI-compatible API |
-| `python -m inferno run <model>` | Chat with a model interactively |
-| `python -m inferno remove <model>` | Remove a downloaded model |
-| `python -m inferno version` | Show version information |
+| `inferno pull <model>` | Download a model from Hugging Face |
+| `inferno list` | List downloaded models |
+| `inferno serve <model>` | Start a model server with OpenAI-compatible API |
+| `inferno run <model>` | Chat with a model interactively |
+| `inferno remove <model>` | Remove a downloaded model |
+| `inferno version` | Show version information |
+
+For more information, visit the [Inferno GitHub repository](https://github.com/HelpingAI/inferno) or [PyPI package page](https://pypi.org/project/inferno-llm/).
+</p>
+</details>
 
 > [!NOTE]
-> Hardware requirements for running models:
+> **Hardware requirements for running models with Inferno:**
 > - Around 2 GB of RAM for 1B models
 > - Around 4 GB of RAM for 3B models
 > - At least 8 GB of RAM for 7B models
@@ -225,7 +282,7 @@ python -m inferno --help
 > - 32 GB of RAM for 33B models
 > - GPU acceleration is recommended for better performance
 
-
+<hr/>
 
 ## 🔍 Search Engines
 
@@ -303,11 +360,15 @@ from webscout import search
 results = search("Python programming", num_results=5)
 ```
 
+<hr/>
+
 ## 🦆 DuckDuckGo Search with WEBS and AsyncWEBS
 
 Webscout provides powerful interfaces to DuckDuckGo's search capabilities through the `WEBS` and `AsyncWEBS` classes.
 
-### Synchronous Usage with WEBS
+<details open>
+<summary><b>Synchronous Usage with WEBS</b></summary>
+<p>
 
 ```python
 from webscout import WEBS
@@ -319,8 +380,12 @@ with WEBS() as webs:
     for result in results:
         print(f"Title: {result['title']}\nURL: {result['url']}")
 ```
+</p>
+</details>
 
-### Asynchronous Usage with AsyncWEBS
+<details open>
+<summary><b>Asynchronous Usage with AsyncWEBS</b></summary>
+<p>
 
 ```python
 import asyncio
@@ -348,10 +413,14 @@ async def main():
 # Run the async function
 asyncio.run(main())
 ```
+</p>
+</details>
 
-> [!NOTE]
+> [!TIP]
 > Always use these classes with a context manager (`with` statement) to ensure proper resource management and cleanup.
 
+<hr/>
+
 ## 💻 WEBS API Reference
 
 The WEBS class provides comprehensive access to DuckDuckGo's search capabilities through a clean, intuitive API.
@@ -370,7 +439,9 @@ The WEBS class provides comprehensive access to DuckDuckGo's search capabilities
 | `suggestions()` | Search suggestions | `webs.suggestions('how to')` |
 | `weather()` | Weather information | `webs.weather('london')` |
 
-### Example: Text Search
+<details>
+<summary><b>Example: Text Search</b></summary>
+<p>
 
 ```python
 from webscout import WEBS
@@ -389,8 +460,12 @@ with WEBS() as webs:
         print(f"URL: {result['url']}")
         print(f"Description: {result['body']}\n")
 ```
+</p>
+</details>
 
-### Example: News Search with Formatting
+<details>
+<summary><b>Example: News Search with Formatting</b></summary>
+<p>
 
 ```python
 from webscout import WEBS
@@ -428,8 +503,12 @@ def fetch_formatted_news(keywords, timelimit='d', max_results=20):
 news = fetch_formatted_news('artificial intelligence', timelimit='w', max_results=5)
 print('\n'.join(news))
 ```
+</p>
+</details>
 
-### Example: Weather Information
+<details>
+<summary><b>Example: Weather Information</b></summary>
+<p>
 
 ```python
 from webscout import WEBS
@@ -444,12 +523,18 @@ with WEBS() as webs:
         print(f"Temperature: {weather.get('temperature', 'N/A')}")
         print(f"Conditions: {weather.get('condition', 'N/A')}")
 ```
+</p>
+</details>
+
+<hr/>
 
 ## 🤖 AI Models and Voices
 
 Webscout provides easy access to a wide range of AI models and voice options.
 
-### LLM Models
+<details open>
+<summary><b>LLM Models</b></summary>
+<p>
 
 Access and manage Large Language Models with Webscout's model utilities.
 
@@ -477,8 +562,12 @@ if isinstance(available_models, list):
 else:
     print(f"  {available_models}")
 ```
+</p>
+</details>
 
-### TTS Voices
+<details open>
+<summary><b>TTS Voices</b></summary>
+<p>
 
 Access and manage Text-to-Speech voices across multiple providers.
 
@@ -506,6 +595,10 @@ if isinstance(available_voices, dict):
     if len(available_voices) > 5:
         print(f"  ... and {len(available_voices) - 5} more")
 ```
+</p>
+</details>
+
+<hr/>
 
 ## 💬 AI Chat Providers
 
@@ -513,6 +606,8 @@ Webscout offers a comprehensive collection of AI chat providers, giving you acce
 
 ### Popular AI Providers
 
+<div class="provider-table">
+
 | Provider | Description | Key Features |
 |----------|-------------|-------------|
 | `OPENAI` | OpenAI's models | GPT-3.5, GPT-4, tool calling |
@@ -528,7 +623,11 @@ Webscout offers a comprehensive collection of AI chat providers, giving you acce
 | `ChatGPTClone` | ChatGPT-like interface | Multiple model options |
 | `TypeGPT` | TypeChat models | Code generation focus |
 
-### Example: Using Duckchat
+</div>
+
+<details>
+<summary><b>Example: Using Duckchat</b></summary>
+<p>
 
 ```python
 from webscout import WEBS
@@ -541,8 +640,12 @@ with WEBS() as webs:
     )
     print(response)
 ```
+</p>
+</details>
 
-### Example: Using Meta AI
+<details>
+<summary><b>Example: Using Meta AI</b></summary>
+<p>
 
 ```python
 from webscout import Meta
@@ -567,8 +670,12 @@ response = meta_ai.ask("Create an image of a futuristic city")
 for media in response.get("media", []):
     print(media["url"])
 ```
+</p>
+</details>
 
-### Example: GROQ with Tool Calling
+<details>
+<summary><b>Example: GROQ with Tool Calling</b></summary>
+<p>
 
 ```python
 from webscout import GROQ, WEBS
@@ -643,10 +750,16 @@ print(response)
 response = client.chat("Find information about quantum computing", tools=tools)
 print(response)
 ```
+</p>
+</details>
+
+<hr/>
 
 ## 👨‍💻 Advanced AI Interfaces
 
-### Direct Model Access with LLM and VLM
+<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.
 
@@ -673,8 +786,12 @@ response = vlm.chat([
 ])
 print(response)
 ```
+</p>
+</details>
 
-### GGUF Model Conversion
+<details open>
+<summary><b>GGUF Model Conversion</b></summary>
+<p>
 
 Webscout provides tools to convert and quantize Hugging Face models into the GGUF format for offline use.
 
@@ -716,6 +833,8 @@ converter.convert()
 ```bash
 python -m webscout.Extra.gguf convert -m "mistralai/Mistral-7B-Instruct-v0.2" -q "q4_k_m"
 ```
+</p>
+</details>
 
 <div align="center">
   <p>
@@ -724,6 +843,8 @@ python -m webscout.Extra.gguf convert -m "mistralai/Mistral-7B-Instruct-v0.2" -q
   </p>
 </div>
 
+<hr/>
+
 ## 🤝 Contributing
 
 Contributions are welcome! If you'd like to contribute to Webscout, please follow these steps:
@@ -739,7 +860,7 @@ Contributions are welcome! If you'd like to contribute to Webscout, please follo
 * All the amazing developers who have contributed to the project
 * The open-source community for their support and inspiration
 
----
+<hr/>
 
 <div align="center">
   <p>Made with ❤️ by the Webscout team</p>