webscout 8.0__py3-none-any.whl → 8.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of webscout might be problematic. Click here for more details.

Files changed (80) hide show
  1. inferno/__init__.py +6 -0
  2. inferno/__main__.py +9 -0
  3. inferno/cli.py +6 -0
  4. webscout/Local/__init__.py +6 -0
  5. webscout/Local/__main__.py +9 -0
  6. webscout/Local/api.py +576 -0
  7. webscout/Local/cli.py +338 -0
  8. webscout/Local/config.py +75 -0
  9. webscout/Local/llm.py +188 -0
  10. webscout/Local/model_manager.py +205 -0
  11. webscout/Local/server.py +187 -0
  12. webscout/Local/utils.py +93 -0
  13. webscout/Provider/AISEARCH/DeepFind.py +1 -1
  14. webscout/Provider/AISEARCH/ISou.py +1 -1
  15. webscout/Provider/AISEARCH/Perplexity.py +359 -0
  16. webscout/Provider/AISEARCH/__init__.py +3 -1
  17. webscout/Provider/AISEARCH/felo_search.py +1 -1
  18. webscout/Provider/AISEARCH/genspark_search.py +1 -1
  19. webscout/Provider/AISEARCH/hika_search.py +1 -1
  20. webscout/Provider/AISEARCH/iask_search.py +436 -0
  21. webscout/Provider/AISEARCH/scira_search.py +9 -5
  22. webscout/Provider/AISEARCH/webpilotai_search.py +1 -1
  23. webscout/Provider/ExaAI.py +1 -1
  24. webscout/Provider/ExaChat.py +18 -8
  25. webscout/Provider/GithubChat.py +5 -1
  26. webscout/Provider/Glider.py +4 -2
  27. webscout/Provider/Jadve.py +2 -2
  28. webscout/Provider/OPENAI/__init__.py +24 -0
  29. webscout/Provider/OPENAI/base.py +46 -0
  30. webscout/Provider/OPENAI/c4ai.py +347 -0
  31. webscout/Provider/OPENAI/chatgpt.py +549 -0
  32. webscout/Provider/OPENAI/chatgptclone.py +460 -0
  33. webscout/Provider/OPENAI/deepinfra.py +284 -0
  34. webscout/Provider/OPENAI/exaai.py +419 -0
  35. webscout/Provider/OPENAI/exachat.py +433 -0
  36. webscout/Provider/OPENAI/freeaichat.py +355 -0
  37. webscout/Provider/OPENAI/glider.py +316 -0
  38. webscout/Provider/OPENAI/heckai.py +337 -0
  39. webscout/Provider/OPENAI/llmchatco.py +327 -0
  40. webscout/Provider/OPENAI/netwrck.py +348 -0
  41. webscout/Provider/OPENAI/opkfc.py +488 -0
  42. webscout/Provider/OPENAI/scirachat.py +463 -0
  43. webscout/Provider/OPENAI/sonus.py +294 -0
  44. webscout/Provider/OPENAI/standardinput.py +425 -0
  45. webscout/Provider/OPENAI/textpollinations.py +285 -0
  46. webscout/Provider/OPENAI/toolbaz.py +405 -0
  47. webscout/Provider/OPENAI/typegpt.py +361 -0
  48. webscout/Provider/OPENAI/uncovrAI.py +455 -0
  49. webscout/Provider/OPENAI/utils.py +211 -0
  50. webscout/Provider/OPENAI/venice.py +428 -0
  51. webscout/Provider/OPENAI/wisecat.py +381 -0
  52. webscout/Provider/OPENAI/writecream.py +158 -0
  53. webscout/Provider/OPENAI/x0gpt.py +389 -0
  54. webscout/Provider/OPENAI/yep.py +329 -0
  55. webscout/Provider/StandardInput.py +278 -0
  56. webscout/Provider/TextPollinationsAI.py +27 -28
  57. webscout/Provider/Venice.py +1 -1
  58. webscout/Provider/Writecream.py +211 -0
  59. webscout/Provider/WritingMate.py +197 -0
  60. webscout/Provider/Youchat.py +30 -26
  61. webscout/Provider/__init__.py +14 -6
  62. webscout/Provider/koala.py +2 -2
  63. webscout/Provider/llmchatco.py +5 -0
  64. webscout/Provider/scira_chat.py +18 -12
  65. webscout/Provider/scnet.py +187 -0
  66. webscout/Provider/toolbaz.py +320 -0
  67. webscout/Provider/typegpt.py +3 -184
  68. webscout/Provider/uncovr.py +3 -3
  69. webscout/conversation.py +32 -32
  70. webscout/prompt_manager.py +2 -1
  71. webscout/version.py +1 -1
  72. webscout-8.2.dist-info/METADATA +734 -0
  73. {webscout-8.0.dist-info → webscout-8.2.dist-info}/RECORD +77 -32
  74. webscout-8.2.dist-info/entry_points.txt +5 -0
  75. {webscout-8.0.dist-info → webscout-8.2.dist-info}/top_level.txt +1 -0
  76. webscout/Provider/flowith.py +0 -207
  77. webscout-8.0.dist-info/METADATA +0 -995
  78. webscout-8.0.dist-info/entry_points.txt +0 -3
  79. {webscout-8.0.dist-info → webscout-8.2.dist-info}/LICENSE.md +0 -0
  80. {webscout-8.0.dist-info → webscout-8.2.dist-info}/WHEEL +0 -0
@@ -0,0 +1,734 @@
1
+ Metadata-Version: 2.1
2
+ Name: webscout
3
+ Version: 8.2
4
+ 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
5
+ Author: OEvortex
6
+ Author-email: helpingai5@gmail.com
7
+ License: HelpingAI
8
+ Project-URL: Source, https://github.com/OE-LUCIFER/Webscout
9
+ Project-URL: Tracker, https://github.com/OE-LUCIFER/Webscout/issues
10
+ Project-URL: YouTube, https://youtube.com/@OEvortex
11
+ Keywords: search,ai,chatbot,llm,language-model,gpt,openai,gemini,claude,llama,search-engine,text-to-speech,tts,text-to-image,tti,weather,youtube,toolkit,utilities,web-search,duckduckgo,google,yep
12
+ Classifier: Development Status :: 5 - Production/Stable
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Intended Audience :: End Users/Desktop
15
+ Classifier: Intended Audience :: Science/Research
16
+ Classifier: License :: Other/Proprietary License
17
+ Classifier: Natural Language :: English
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Operating System :: Microsoft :: Windows
20
+ Classifier: Operating System :: POSIX :: Linux
21
+ Classifier: Operating System :: MacOS :: MacOS X
22
+ Classifier: Programming Language :: Python :: 3
23
+ Classifier: Programming Language :: Python :: 3.9
24
+ Classifier: Programming Language :: Python :: 3.10
25
+ Classifier: Programming Language :: Python :: 3.11
26
+ Classifier: Programming Language :: Python :: 3.12
27
+ Classifier: Programming Language :: Python :: 3.13
28
+ Classifier: Programming Language :: Python :: Implementation :: CPython
29
+ Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
30
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
31
+ Classifier: Topic :: Text Processing :: Linguistic
32
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
33
+ Classifier: Topic :: Communications
34
+ Classifier: Topic :: Utilities
35
+ Requires-Python: >=3.9
36
+ Description-Content-Type: text/markdown
37
+ License-File: LICENSE.md
38
+ Requires-Dist: setuptools
39
+ Requires-Dist: wheel
40
+ Requires-Dist: pip
41
+ Requires-Dist: nodriver
42
+ Requires-Dist: mistune
43
+ Requires-Dist: tenacity
44
+ Requires-Dist: curl-cffi
45
+ Requires-Dist: nest-asyncio
46
+ Requires-Dist: websocket-client
47
+ Requires-Dist: colorama
48
+ Requires-Dist: rich
49
+ Requires-Dist: markdownify
50
+ Requires-Dist: requests
51
+ Requires-Dist: google-generativeai
52
+ Requires-Dist: lxml>=5.2.2
53
+ Requires-Dist: termcolor
54
+ Requires-Dist: orjson
55
+ Requires-Dist: PyYAML
56
+ Requires-Dist: ollama
57
+ Requires-Dist: pillow
58
+ Requires-Dist: bson
59
+ Requires-Dist: cloudscraper
60
+ Requires-Dist: html5lib
61
+ Requires-Dist: aiofiles
62
+ Requires-Dist: openai
63
+ Requires-Dist: prompt-toolkit
64
+ Requires-Dist: primp
65
+ Requires-Dist: pyreqwest-impersonate
66
+ Requires-Dist: gradio-client
67
+ Requires-Dist: psutil
68
+ Requires-Dist: aiohttp
69
+ Provides-Extra: local
70
+ Requires-Dist: llama-cpp-python; extra == "local"
71
+ Requires-Dist: fastapi; extra == "local"
72
+ Requires-Dist: uvicorn; extra == "local"
73
+ Requires-Dist: rich; extra == "local"
74
+ Requires-Dist: typer; extra == "local"
75
+ Requires-Dist: huggingface-hub; extra == "local"
76
+ Requires-Dist: pydantic; extra == "local"
77
+ Requires-Dist: requests; extra == "local"
78
+ Provides-Extra: dev
79
+ Requires-Dist: ruff>=0.1.6; extra == "dev"
80
+ Requires-Dist: pytest>=7.4.2; extra == "dev"
81
+
82
+ <div align="center">
83
+ <a href="https://github.com/OEvortex/Webscout">
84
+ <img src="https://img.shields.io/badge/WebScout-Ultimate%20Toolkit-blue?style=for-the-badge&logo=python&logoColor=white" alt="WebScout Logo">
85
+ </a>
86
+
87
+ <h1>Webscout</h1>
88
+
89
+ <p><strong>Your All-in-One Python Toolkit for Web Search, AI Interaction, Digital Utilities, and More</strong></p>
90
+
91
+ <p>
92
+ Access diverse search engines, cutting-edge AI models, temporary communication tools, media utilities, developer helpers, and powerful CLI interfaces – all through one unified library.
93
+ </p>
94
+
95
+ <!-- Badges -->
96
+ <p>
97
+ <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>
98
+ <a href="https://pepy.tech/project/webscout"><img src="https://static.pepy.tech/badge/webscout/month?style=flat-square" alt="Monthly Downloads"></a>
99
+ <a href="https://pepy.tech/project/webscout"><img src="https://static.pepy.tech/badge/webscout?style=flat-square" alt="Total Downloads"></a>
100
+ <a href="#"><img src="https://img.shields.io/pypi/pyversions/webscout?style=flat-square&logo=python" alt="Python Version"></a>
101
+ </p>
102
+ </div>
103
+
104
+ > [!IMPORTANT]
105
+ > Webscout supports three types of compatibility:
106
+ > - **Native Compatibility:** Webscout's own native API for maximum flexibility
107
+ > - **OpenAI Compatibility:** Use providers with OpenAI-compatible interfaces
108
+ > - **Local LLM Compatibility:** Run local models with [Inferno](webscout/Local/README.md), an OpenAI-compatible server
109
+ >
110
+ > Choose the approach that best fits your needs! For OpenAI compatibility, check the [OpenAI Providers README](webscout/Provider/OPENAI/README.md).
111
+
112
+ > [!NOTE]
113
+ > 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.
114
+
115
+ <div align="center">
116
+ <!-- Social/Support Links -->
117
+ <p>
118
+ <a href="https://t.me/PyscoutAI"><img alt="Telegram Group" src="https://img.shields.io/badge/Telegram%20Group-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
119
+ <a href="https://t.me/ANONYMOUS_56788"><img alt="Developer Telegram" src="https://img.shields.io/badge/Developer%20Contact-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
120
+ <a href="https://youtube.com/@OEvortex"><img alt="YouTube" src="https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white"></a>
121
+ <a href="https://www.linkedin.com/in/oe-vortex-29a407265/"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white"></a>
122
+ <a href="https://www.instagram.com/oevortex/"><img alt="Instagram" src="https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white"></a>
123
+ <a href="https://buymeacoffee.com/oevortex"><img alt="Buy Me A Coffee" src="https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=black"></a>
124
+ </p>
125
+ </div>
126
+
127
+
128
+ ## 🚀 Features
129
+
130
+ ### Search & AI
131
+ * **Comprehensive Search:** Leverage Google, DuckDuckGo, and Yep for diverse search results
132
+ * **AI Powerhouse:** Access and interact with various AI models through three compatibility options:
133
+ * **Native API:** Use Webscout's native interfaces for providers like OpenAI, Cohere, Gemini, and many more
134
+ * **[OpenAI-Compatible Providers](webscout/Provider/OPENAI/README.md):** Seamlessly integrate with various AI providers using standardized OpenAI-compatible interfaces
135
+ * **[Local LLMs with Inferno](webscout/Local/README.md):** Run local models with an OpenAI-compatible server
136
+ * **[AI Search](webscout/Provider/AISEARCH/README.md):** AI-powered search engines with advanced capabilities
137
+
138
+ ### Media & Content Tools
139
+ * **[YouTube Toolkit](webscout/Extra/YTToolkit/README.md):** Advanced YouTube video and transcript management with multi-language support
140
+ * **[Text-to-Speech (TTS)](webscout/Provider/TTS/README.md):** Convert text into natural-sounding speech using multiple AI-powered providers
141
+ * **[Text-to-Image](webscout/Provider/TTI/README.md):** Generate high-quality images using a wide range of AI art providers
142
+ * **[Weather Tools](webscout/Extra/weather.md):** Retrieve detailed weather information for any location
143
+
144
+ ### Developer Tools
145
+ * **[GitAPI](webscout/Extra/GitToolkit/gitapi):** Powerful GitHub data extraction toolkit without authentication requirements for public data
146
+ * **[SwiftCLI](webscout/swiftcli/Readme.md):** A powerful and elegant CLI framework for beautiful command-line interfaces
147
+ * **[LitPrinter](webscout/litprinter/Readme.md):** Styled console output with rich formatting and colors
148
+ * **[LitLogger](webscout/litlogger/Readme.md):** Simplified logging with customizable formats and color schemes
149
+ * **[LitAgent](webscout/litagent/Readme.md):** Modern user agent generator that keeps your requests undetectable
150
+ * **[Scout](webscout/scout/README.md):** Advanced web parsing and crawling library with intelligent HTML/XML parsing
151
+ * **[Inferno](webscout/Local/README.md):** Run local LLMs with an OpenAI-compatible API and interactive CLI
152
+ * **GGUF Conversion:** Convert and quantize Hugging Face models to GGUF format
153
+
154
+ ### Privacy & Utilities
155
+ * **[Tempmail](webscout/Extra/tempmail/README.md) & Temp Number:** Generate temporary email addresses and phone numbers
156
+ * **[Awesome Prompts](webscout/Extra/Act.md):** Curated collection of system prompts for specialized AI personas
157
+
158
+ ## ⚙️ Installation
159
+
160
+ Install Webscout using pip:
161
+
162
+ ```bash
163
+ pip install -U webscout
164
+ ```
165
+
166
+ ## 🖥️ Command Line Interface
167
+
168
+ Webscout provides a powerful command-line interface for quick access to its features:
169
+
170
+ ```bash
171
+ python -m webscout --help
172
+ ```
173
+
174
+ ### Web Search Commands
175
+
176
+ | Command | Description |
177
+ |---------|-------------|
178
+ | `python -m webscout answers -k "query"` | Perform an answers search |
179
+ | `python -m webscout chat` | Start an interactive AI chat session |
180
+ | `python -m webscout images -k "query"` | Search for images |
181
+ | `python -m webscout maps -k "query"` | Perform a maps search |
182
+ | `python -m webscout news -k "query"` | Search for news articles |
183
+ | `python -m webscout suggestions -k "query"` | Get search suggestions |
184
+ | `python -m webscout text -k "query"` | Perform a text search |
185
+ | `python -m webscout translate -k "text"` | Translate text |
186
+ | `python -m webscout version` | Display the current version |
187
+ | `python -m webscout videos -k "query"` | Search for videos |
188
+ | `python -m webscout weather -l "location"` | Get weather information |
189
+
190
+ ### Inferno LLM Commands
191
+
192
+ Inferno provides commands for managing and using local LLMs:
193
+
194
+ ```bash
195
+ python -m inferno --help
196
+ ```
197
+
198
+ | Command | Description |
199
+ |---------|-------------|
200
+ | `python -m inferno pull <model>` | Download a model from Hugging Face |
201
+ | `python -m inferno list` | List downloaded models |
202
+ | `python -m inferno serve <model>` | Start a model server with OpenAI-compatible API |
203
+ | `python -m inferno run <model>` | Chat with a model interactively |
204
+ | `python -m inferno remove <model>` | Remove a downloaded model |
205
+ | `python -m inferno version` | Show version information |
206
+
207
+ > [!NOTE]
208
+ > Hardware requirements for running models:
209
+ > - Around 2 GB of RAM for 1B models
210
+ > - Around 4 GB of RAM for 3B models
211
+ > - At least 8 GB of RAM for 7B models
212
+ > - 16 GB of RAM for 13B models
213
+ > - 32 GB of RAM for 33B models
214
+ > - GPU acceleration is recommended for better performance
215
+
216
+
217
+
218
+ ## 🔍 Search Engines
219
+
220
+ Webscout provides multiple search engine interfaces for diverse search capabilities.
221
+
222
+ ### YepSearch - Yep.com Interface
223
+
224
+ ```python
225
+ from webscout import YepSearch
226
+
227
+ # Initialize YepSearch
228
+ yep = YepSearch(
229
+ timeout=20, # Optional: Set custom timeout
230
+ proxies=None, # Optional: Use proxies
231
+ verify=True # Optional: SSL verification
232
+ )
233
+
234
+ # Text Search
235
+ text_results = yep.text(
236
+ keywords="artificial intelligence",
237
+ region="all", # Optional: Region for results
238
+ safesearch="moderate", # Optional: "on", "moderate", "off"
239
+ max_results=10 # Optional: Limit number of results
240
+ )
241
+
242
+ # Image Search
243
+ image_results = yep.images(
244
+ keywords="nature photography",
245
+ region="all",
246
+ safesearch="moderate",
247
+ max_results=10
248
+ )
249
+
250
+ # Get search suggestions
251
+ suggestions = yep.suggestions("hist")
252
+ ```
253
+
254
+ ### GoogleSearch - Google Interface
255
+
256
+ ```python
257
+ from webscout import GoogleSearch
258
+
259
+ # Initialize GoogleSearch
260
+ google = GoogleSearch(
261
+ timeout=10, # Optional: Set custom timeout
262
+ proxies=None, # Optional: Use proxies
263
+ verify=True # Optional: SSL verification
264
+ )
265
+
266
+ # Text Search
267
+ text_results = google.text(
268
+ keywords="artificial intelligence",
269
+ region="us", # Optional: Region for results
270
+ safesearch="moderate", # Optional: "on", "moderate", "off"
271
+ max_results=10 # Optional: Limit number of results
272
+ )
273
+ for result in text_results:
274
+ print(f"Title: {result.title}")
275
+ print(f"URL: {result.url}")
276
+ print(f"Description: {result.description}")
277
+
278
+ # News Search
279
+ news_results = google.news(
280
+ keywords="technology trends",
281
+ region="us",
282
+ safesearch="moderate",
283
+ max_results=5
284
+ )
285
+
286
+ # Get search suggestions
287
+ suggestions = google.suggestions("how to")
288
+
289
+ # Legacy usage is still supported
290
+ from webscout import search
291
+ results = search("Python programming", num_results=5)
292
+ ```
293
+
294
+ ## 🦆 DuckDuckGo Search with WEBS and AsyncWEBS
295
+
296
+ Webscout provides powerful interfaces to DuckDuckGo's search capabilities through the `WEBS` and `AsyncWEBS` classes.
297
+
298
+ ### Synchronous Usage with WEBS
299
+
300
+ ```python
301
+ from webscout import WEBS
302
+
303
+ # Use as a context manager for proper resource management
304
+ with WEBS() as webs:
305
+ # Simple text search
306
+ results = webs.text("python programming", max_results=5)
307
+ for result in results:
308
+ print(f"Title: {result['title']}\nURL: {result['url']}")
309
+ ```
310
+
311
+ ### Asynchronous Usage with AsyncWEBS
312
+
313
+ ```python
314
+ import asyncio
315
+ from webscout import AsyncWEBS
316
+
317
+ async def search_multiple_terms(search_terms):
318
+ async with AsyncWEBS() as webs:
319
+ # Create tasks for each search term
320
+ tasks = [webs.text(term, max_results=5) for term in search_terms]
321
+ # Run all searches concurrently
322
+ results = await asyncio.gather(*tasks)
323
+ return results
324
+
325
+ async def main():
326
+ terms = ["python", "javascript", "machine learning"]
327
+ all_results = await search_multiple_terms(terms)
328
+
329
+ # Process results
330
+ for i, term_results in enumerate(all_results):
331
+ print(f"Results for '{terms[i]}':\n")
332
+ for result in term_results:
333
+ print(f"- {result['title']}")
334
+ print("\n")
335
+
336
+ # Run the async function
337
+ asyncio.run(main())
338
+ ```
339
+
340
+ > [!NOTE]
341
+ > Always use these classes with a context manager (`with` statement) to ensure proper resource management and cleanup.
342
+
343
+ ## 💻 WEBS API Reference
344
+
345
+ The WEBS class provides comprehensive access to DuckDuckGo's search capabilities through a clean, intuitive API.
346
+
347
+ ### Available Search Methods
348
+
349
+ | Method | Description | Example |
350
+ |--------|-------------|--------|
351
+ | `text()` | General web search | `webs.text('python programming')` |
352
+ | `answers()` | Instant answers | `webs.answers('population of france')` |
353
+ | `images()` | Image search | `webs.images('nature photography')` |
354
+ | `videos()` | Video search | `webs.videos('documentary')` |
355
+ | `news()` | News articles | `webs.news('technology')` |
356
+ | `maps()` | Location search | `webs.maps('restaurants', place='new york')` |
357
+ | `translate()` | Text translation | `webs.translate('hello', to='es')` |
358
+ | `suggestions()` | Search suggestions | `webs.suggestions('how to')` |
359
+ | `weather()` | Weather information | `webs.weather('london')` |
360
+
361
+ ### Example: Text Search
362
+
363
+ ```python
364
+ from webscout import WEBS
365
+
366
+ with WEBS() as webs:
367
+ results = webs.text(
368
+ 'artificial intelligence',
369
+ region='wt-wt', # Optional: Region for results
370
+ safesearch='off', # Optional: 'on', 'moderate', 'off'
371
+ timelimit='y', # Optional: Time limit ('d'=day, 'w'=week, 'm'=month, 'y'=year)
372
+ max_results=10 # Optional: Limit number of results
373
+ )
374
+
375
+ for result in results:
376
+ print(f"Title: {result['title']}")
377
+ print(f"URL: {result['url']}")
378
+ print(f"Description: {result['body']}\n")
379
+ ```
380
+
381
+ ### Example: News Search with Formatting
382
+
383
+ ```python
384
+ from webscout import WEBS
385
+ import datetime
386
+
387
+ def fetch_formatted_news(keywords, timelimit='d', max_results=20):
388
+ """Fetch and format news articles"""
389
+ with WEBS() as webs:
390
+ # Get news results
391
+ news_results = webs.news(
392
+ keywords,
393
+ region="wt-wt",
394
+ safesearch="off",
395
+ timelimit=timelimit, # 'd'=day, 'w'=week, 'm'=month
396
+ max_results=max_results
397
+ )
398
+
399
+ # Format the results
400
+ formatted_news = []
401
+ for i, item in enumerate(news_results, 1):
402
+ # Format the date
403
+ date = datetime.datetime.fromisoformat(item['date']).strftime('%B %d, %Y')
404
+
405
+ # Create formatted entry
406
+ entry = f"{i}. {item['title']}\n"
407
+ entry += f" Published: {date}\n"
408
+ entry += f" {item['body']}\n"
409
+ entry += f" URL: {item['url']}\n"
410
+
411
+ formatted_news.append(entry)
412
+
413
+ return formatted_news
414
+
415
+ # Example usage
416
+ news = fetch_formatted_news('artificial intelligence', timelimit='w', max_results=5)
417
+ print('\n'.join(news))
418
+ ```
419
+
420
+ ### Example: Weather Information
421
+
422
+ ```python
423
+ from webscout import WEBS
424
+
425
+ with WEBS() as webs:
426
+ # Get weather for a location
427
+ weather = webs.weather("New York")
428
+
429
+ # Access weather data
430
+ if weather:
431
+ print(f"Location: {weather.get('location', 'Unknown')}")
432
+ print(f"Temperature: {weather.get('temperature', 'N/A')}")
433
+ print(f"Conditions: {weather.get('condition', 'N/A')}")
434
+ ```
435
+
436
+ ## 🤖 AI Models and Voices
437
+
438
+ Webscout provides easy access to a wide range of AI models and voice options.
439
+
440
+ ### LLM Models
441
+
442
+ Access and manage Large Language Models with Webscout's model utilities.
443
+
444
+ ```python
445
+ from webscout import model
446
+ from rich import print
447
+
448
+ # List all available LLM models
449
+ all_models = model.llm.list()
450
+ print(f"Total available models: {len(all_models)}")
451
+
452
+ # Get a summary of models by provider
453
+ summary = model.llm.summary()
454
+ print("Models by provider:")
455
+ for provider, count in summary.items():
456
+ print(f" {provider}: {count} models")
457
+
458
+ # Get models for a specific provider
459
+ provider_name = "PerplexityLabs"
460
+ available_models = model.llm.get(provider_name)
461
+ print(f"\n{provider_name} models:")
462
+ if isinstance(available_models, list):
463
+ for i, model_name in enumerate(available_models, 1):
464
+ print(f" {i}. {model_name}")
465
+ else:
466
+ print(f" {available_models}")
467
+ ```
468
+
469
+ ### TTS Voices
470
+
471
+ Access and manage Text-to-Speech voices across multiple providers.
472
+
473
+ ```python
474
+ from webscout import model
475
+ from rich import print
476
+
477
+ # List all available TTS voices
478
+ all_voices = model.tts.list()
479
+ print(f"Total available voices: {len(all_voices)}")
480
+
481
+ # Get a summary of voices by provider
482
+ summary = model.tts.summary()
483
+ print("\nVoices by provider:")
484
+ for provider, count in summary.items():
485
+ print(f" {provider}: {count} voices")
486
+
487
+ # Get voices for a specific provider
488
+ provider_name = "ElevenlabsTTS"
489
+ available_voices = model.tts.get(provider_name)
490
+ print(f"\n{provider_name} voices:")
491
+ if isinstance(available_voices, dict):
492
+ for voice_name, voice_id in list(available_voices.items())[:5]: # Show first 5 voices
493
+ print(f" - {voice_name}: {voice_id}")
494
+ if len(available_voices) > 5:
495
+ print(f" ... and {len(available_voices) - 5} more")
496
+ ```
497
+
498
+ ## 💬 AI Chat Providers
499
+
500
+ Webscout offers a comprehensive collection of AI chat providers, giving you access to various language models through a consistent interface.
501
+
502
+ ### Popular AI Providers
503
+
504
+ | Provider | Description | Key Features |
505
+ |----------|-------------|-------------|
506
+ | `OPENAI` | OpenAI's models | GPT-3.5, GPT-4, tool calling |
507
+ | `GEMINI` | Google's Gemini models | Web search capabilities |
508
+ | `Meta` | Meta's AI assistant | Image generation, web search |
509
+ | `GROQ` | Fast inference platform | High-speed inference, tool calling |
510
+ | `LLAMA` | Meta's Llama models | Open weights models |
511
+ | `DeepInfra` | Various open models | Multiple model options |
512
+ | `Cohere` | Cohere's language models | Command models |
513
+ | `PerplexityLabs` | Perplexity AI | Web search integration |
514
+ | `Anthropic` | Claude models | Long context windows |
515
+ | `YEPCHAT` | Yep.com's AI | Streaming responses |
516
+ | `ChatGPTClone` | ChatGPT-like interface | Multiple model options |
517
+ | `TypeGPT` | TypeChat models | Code generation focus |
518
+
519
+ ### Example: Using Duckchat
520
+
521
+ ```python
522
+ from webscout import WEBS
523
+
524
+ # Initialize and use Duckchat
525
+ with WEBS() as webs:
526
+ response = webs.chat(
527
+ "Explain quantum computing in simple terms",
528
+ model='gpt-4o-mini' # Options: mixtral-8x7b, llama-3.1-70b, claude-3-haiku, etc.
529
+ )
530
+ print(response)
531
+ ```
532
+
533
+ ### Example: Using Meta AI
534
+
535
+ ```python
536
+ from webscout import Meta
537
+
538
+ # For basic usage (no authentication required)
539
+ meta_ai = Meta()
540
+
541
+ # Simple text prompt
542
+ response = meta_ai.chat("What is the capital of France?")
543
+ print(response)
544
+
545
+ # For authenticated usage with web search and image generation
546
+ meta_ai = Meta(fb_email="your_email@example.com", fb_password="your_password")
547
+
548
+ # Text prompt with web search
549
+ response = meta_ai.ask("What are the latest developments in quantum computing?")
550
+ print(response["message"])
551
+ print("Sources:", response["sources"])
552
+
553
+ # Image generation
554
+ response = meta_ai.ask("Create an image of a futuristic city")
555
+ for media in response.get("media", []):
556
+ print(media["url"])
557
+ ```
558
+
559
+ ### Example: GROQ with Tool Calling
560
+
561
+ ```python
562
+ from webscout import GROQ, WEBS
563
+ import json
564
+
565
+ # Initialize GROQ client
566
+ client = GROQ(api_key="your_api_key")
567
+
568
+ # Define helper functions
569
+ def calculate(expression):
570
+ """Evaluate a mathematical expression"""
571
+ try:
572
+ result = eval(expression)
573
+ return json.dumps({"result": result})
574
+ except Exception as e:
575
+ return json.dumps({"error": str(e)})
576
+
577
+ def search(query):
578
+ """Perform a web search"""
579
+ try:
580
+ results = WEBS().text(query, max_results=3)
581
+ return json.dumps({"results": results})
582
+ except Exception as e:
583
+ return json.dumps({"error": str(e)})
584
+
585
+ # Register functions with GROQ
586
+ client.add_function("calculate", calculate)
587
+ client.add_function("search", search)
588
+
589
+ # Define tool specifications
590
+ tools = [
591
+ {
592
+ "type": "function",
593
+ "function": {
594
+ "name": "calculate",
595
+ "description": "Evaluate a mathematical expression",
596
+ "parameters": {
597
+ "type": "object",
598
+ "properties": {
599
+ "expression": {
600
+ "type": "string",
601
+ "description": "The mathematical expression to evaluate"
602
+ }
603
+ },
604
+ "required": ["expression"]
605
+ }
606
+ }
607
+ },
608
+ {
609
+ "type": "function",
610
+ "function": {
611
+ "name": "search",
612
+ "description": "Perform a web search",
613
+ "parameters": {
614
+ "type": "object",
615
+ "properties": {
616
+ "query": {
617
+ "type": "string",
618
+ "description": "The search query"
619
+ }
620
+ },
621
+ "required": ["query"]
622
+ }
623
+ }
624
+ }
625
+ ]
626
+
627
+ # Use the tools
628
+ response = client.chat("What is 25 * 4 + 10?", tools=tools)
629
+ print(response)
630
+
631
+ response = client.chat("Find information about quantum computing", tools=tools)
632
+ print(response)
633
+ ```
634
+
635
+ ## 👨‍💻 Advanced AI Interfaces
636
+
637
+ ### Direct Model Access with LLM and VLM
638
+
639
+ Webscout provides direct interfaces to language and vision-language models through the `LLM` and `VLM` classes.
640
+
641
+ ```python
642
+ from webscout.LLM import LLM, VLM
643
+
644
+ # Text-only model interaction
645
+ llm = LLM("meta-llama/Meta-Llama-3-70B-Instruct")
646
+ response = llm.chat([
647
+ {"role": "user", "content": "Explain the concept of neural networks"}
648
+ ])
649
+ print(response)
650
+
651
+ # Vision-language model interaction
652
+ vlm = VLM("cogvlm-grounding-generalist")
653
+ response = vlm.chat([
654
+ {
655
+ "role": "user",
656
+ "content": [
657
+ {"type": "image", "image_url": "path/to/image.jpg"},
658
+ {"type": "text", "text": "Describe what you see in this image"}
659
+ ]
660
+ }
661
+ ])
662
+ print(response)
663
+ ```
664
+
665
+ ### GGUF Model Conversion
666
+
667
+ Webscout provides tools to convert and quantize Hugging Face models into the GGUF format for offline use.
668
+
669
+ ```python
670
+ from webscout.Extra.gguf import ModelConverter
671
+
672
+ # Create a converter instance
673
+ converter = ModelConverter(
674
+ model_id="mistralai/Mistral-7B-Instruct-v0.2", # Hugging Face model ID
675
+ quantization_methods="q4_k_m" # Quantization method
676
+ )
677
+
678
+ # Run the conversion
679
+ converter.convert()
680
+ ```
681
+
682
+ #### Available Quantization Methods
683
+
684
+ | Method | Description |
685
+ |--------|-------------|
686
+ | `fp16` | 16-bit floating point - maximum accuracy, largest size |
687
+ | `q2_k` | 2-bit quantization (smallest size, lowest accuracy) |
688
+ | `q3_k_l` | 3-bit quantization (large) - balanced for size/accuracy |
689
+ | `q3_k_m` | 3-bit quantization (medium) - good balance for most use cases |
690
+ | `q3_k_s` | 3-bit quantization (small) - optimized for speed |
691
+ | `q4_0` | 4-bit quantization (version 0) - standard 4-bit compression |
692
+ | `q4_1` | 4-bit quantization (version 1) - improved accuracy over q4_0 |
693
+ | `q4_k_m` | 4-bit quantization (medium) - balanced for most models |
694
+ | `q4_k_s` | 4-bit quantization (small) - optimized for speed |
695
+ | `q5_0` | 5-bit quantization (version 0) - high accuracy, larger size |
696
+ | `q5_1` | 5-bit quantization (version 1) - improved accuracy over q5_0 |
697
+ | `q5_k_m` | 5-bit quantization (medium) - best balance for quality/size |
698
+ | `q5_k_s` | 5-bit quantization (small) - optimized for speed |
699
+ | `q6_k` | 6-bit quantization - highest accuracy, largest size |
700
+ | `q8_0` | 8-bit quantization - maximum accuracy, largest size |
701
+
702
+ #### Command Line Usage
703
+
704
+ ```bash
705
+ python -m webscout.Extra.gguf convert -m "mistralai/Mistral-7B-Instruct-v0.2" -q "q4_k_m"
706
+ ```
707
+
708
+ <div align="center">
709
+ <p>
710
+ <a href="https://youtube.com/@OEvortex">▶️ Vortex's YouTube Channel</a> |
711
+ <a href="https://t.me/ANONYMOUS_56788">📢 Anonymous Coder's Telegram</a>
712
+ </p>
713
+ </div>
714
+
715
+ ## 🤝 Contributing
716
+
717
+ Contributions are welcome! If you'd like to contribute to Webscout, please follow these steps:
718
+
719
+ 1. Fork the repository
720
+ 2. Create a new branch for your feature or bug fix
721
+ 3. Make your changes and commit them with descriptive messages
722
+ 4. Push your branch to your forked repository
723
+ 5. Submit a pull request to the main repository
724
+
725
+ ## 🙏 Acknowledgments
726
+
727
+ * All the amazing developers who have contributed to the project
728
+ * The open-source community for their support and inspiration
729
+
730
+ ---
731
+
732
+ <div align="center">
733
+ <p>Made with ❤️ by the Webscout team</p>
734
+ </div>