webscout 1.0.4__tar.gz → 1.0.8__tar.gz

webscout-1.0.8/LICENSE.md

@@ -0,0 +1,50 @@
+****************************************
+**** HelpingAI Simplified Universal License ****
+****************************************
+
+Version 1.0
+
+### Introduction
+
+This HelpingAI Simplified Universal License (HSUL) governs HelpingAI's content, including computer programs, scripts, datasets, documents, images, audio recordings, videos, and other digital assets. The HSUL provides simple, universal terms for accessing, modifying, and sharing resources while embracing ethical development practices.
+
+### Grant of Rights
+
+Under the HSUL, HelpingAI authorizes you to copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Content, subject to the terms and conditions detailed in this document.
+
+### Conditions
+
+To qualify for the rights granted in section 1, you must strictly adhere to the following conditions:
+
+2.1. **Redistributions of Source Code.**
+   If you redistribute the Source Code, you must include the entire HSUL with your distribution. Furthermore, you must add prominent notifications in all affected files stating:
+
+   > "This Work is released under the HelpingAI Simplified Universal License v1.0."
+
+2.2. **Binary Form Redistributions.**
+   If you distribute Binaries generated from the Source Code, you must ensure the inclusion of the following statement in your distribution:
+
+   > "This Work is based upon the HelpingAI Simplified Universally Licensed Work, under the HelpingAI Simplified Universal License v1.0."
+
+2.3. **Notification of Changes.**
+   Clearly indicate any alterations you introduce to the Source Code or Documentation via prominent comments detailing the nature and scope of the change(s). Reference the date and originator of the modifications.
+
+2.4. **Branding Attribution.**
+   Do not remove or alter any HelpingAI branding, logos, or notices included in the Content without explicit prior consent from HelpingAI.
+
+2.5. **Exclusion of Warranty.**
+   The Content is delivered "AS IS," bereft of any implicit guarantee, including — though not constrained to — warranties pertaining to marketability, applicability for a particular purpose, and non-infringement.
+
+2.6. **Limitation of Liability.**
+   To the maximum extent allowed by law, neither HelpingAI nor any contributor shall bear responsibility for any loss, personal injury, property damage, indirect, special, incidental, or consequential damages stemming from or relating to the Content or its employment.
+
+2.7. **Governing Law.**
+   This HSUL shall be managed and construed according to the laws of the jurisdiction where HelpingAI primarily operates.
+
+### Definitions
+
+3.1. **"Source Code"** signifies the preferred form for editing the Content, typically represented by human-readable programming languages, scripts, or documentation formats.
+
+3.2. **"Binaries"** denote compiled forms of the Source Code, executables, libraries, or similar artifacts built from the Source Code.
+
+By leveraging this Content, you confirm your approval of the HSUL and pledge to honor its terms and conditions. If you disagree with the HSUL's rules, refrain from engaging with the Content.

webscout-1.0.8/PKG-INFO

@@ -0,0 +1,453 @@
+Metadata-Version: 2.1
+Name: webscout
+Version: 1.0.8
+Summary: Search for words, documents, images, videos, news, maps and text translation using the DuckDuckGo.com, yep.com, phind.com and you.com Also containes AI models
+Author: OEvortex
+Author-email: helpingai5@gmail.com
+License: HelpingAI Simplified Universal License
+Project-URL: Documentation, https://github.com/OE-LUCIFER/Webscout/wiki
+Project-URL: Source, https://github.com/OE-LUCIFER/Webscout
+Project-URL: Tracker, https://github.com/OE-LUCIFER/Webscout/issues
+Project-URL: YouTube, https://youtube.com/@OEvortex
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: docstring_inheritance>=2.1.2
+Requires-Dist: click>=8.1.7
+Requires-Dist: curl_cffi>=0.6.0b7
+Requires-Dist: lxml>=5.1.0
+Requires-Dist: nest-asyncio>=1.6.0
+Requires-Dist: selenium>=4.1.3
+Requires-Dist: tqdm>=4.64.0
+Requires-Dist: webdriver-manager>=3.5.4
+Requires-Dist: halo>=0.0.31
+Requires-Dist: g4f>=0.2.2.3
+Provides-Extra: dev
+Requires-Dist: ruff>=0.1.6; extra == "dev"
+Requires-Dist: pytest>=7.4.2; extra == "dev"
+
+Search for words, documents, images, videos, news, maps and text translation using the DuckDuckGo.com, yep.com, phind.com and you.com
+Also containes AI models that you can use
+**⚠️ Warning: use AsyncWEBS in asynchronous code**
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Install](#install)
+- [CLI version](#cli-version)
+- [CLI version of AI](#cli-version-of-ai)
+- [Regions](#regions)
+- [WEBS and AsyncWEBS classes](#webs-and-asyncwebs-classes)
+- [Exceptions](#exceptions)
+- [usage](#usage)
+  - [1. `text()` - text search by DuckDuckGo.com and Yep.com](#1-text---text-search-by-duckduckgocom-and-yepcom)
+  - [2. `answers()` - instant answers by DuckDuckGo.com and Yep.com](#2-answers---instant-answers-by-duckduckgocom-and-yepcom)
+  - [3. `images()` - image search by DuckDuckGo.com and Yep.com](#3-images---image-search-by-duckduckgocom-and-yepcom)
+  - [4. `videos()` - video search by DuckDuckGo.com](#4-videos---video-search-by-duckduckgocom)
+  - [5. `news()` - news search by DuckDuckGo.com and yep.com](#5-news---news-search-by-duckduckgocom-and-yepcom)
+  - [6. `maps()` - map search by DuckDuckGo.com and](#6-maps---map-search-by-duckduckgocom-and)
+  - [7. `translate()` - translation by DuckDuckGo.com and Yep.com](#7-translate---translation-by-duckduckgocom-and-yepcom)
+  - [8. `suggestions()` - suggestions by DuckDuckGo.com and Yep.com](#8-suggestions---suggestions-by-duckduckgocom-and-yepcom)
+  - [9. `PhindSearch` - Search using Phind.com](#9-phindsearch---search-using-phindcom)
+  - [10. `YepChat` - Chat with mistral 8x7b powered by yepchat](#10-yepchat---chat-with-mistral-8x7b-powered-by-yepchat)
+  - [11. `You.com` - search with you.com](#11-youcom---search-with-youcom)
+  - [12. `Gemini` - search with google gemini](#12-gemini---search-with-google-gemini)
+- [Version History](#version-history)
+  - [v1.0.7](#v107)
+  - [v1.0.6](#v106)
+
+## Install
+```python
+pip install -U webscout
+```
+
+## CLI version
+
+```python3
+python -m webscout --help
+```
+## CLI version of AI
+
+```python3
+python -m webscout.AI phindsearch --query "your_query_here"
+```
+
+```python
+python -m webscout.AI yepchat --message "your_message_here"
+```
+
+```python
+python -m webscout.AI youchat --prompt "your_prompt_here"
+```
+
+```python
+python -m  webscout.AI gemini --message "tell me about gemma 7b"
+```
+
+[Go To TOP](#TOP)
+
+## Regions
+<details>
+  <summary>expand</summary>
+
+    xa-ar for Arabia
+    xa-en for Arabia (en)
+    ar-es for Argentina
+    au-en for Australia
+    at-de for Austria
+    be-fr for Belgium (fr)
+    be-nl for Belgium (nl)
+    br-pt for Brazil
+    bg-bg for Bulgaria
+    ca-en for Canada
+    ca-fr for Canada (fr)
+    ct-ca for Catalan
+    cl-es for Chile
+    cn-zh for China
+    co-es for Colombia
+    hr-hr for Croatia
+    cz-cs for Czech Republic
+    dk-da for Denmark
+    ee-et for Estonia
+    fi-fi for Finland
+    fr-fr for France
+    de-de for Germany
+    gr-el for Greece
+    hk-tzh for Hong Kong
+    hu-hu for Hungary
+    in-en for India
+    id-id for Indonesia
+    id-en for Indonesia (en)
+    ie-en for Ireland
+    il-he for Israel
+    it-it for Italy
+    jp-jp for Japan
+    kr-kr for Korea
+    lv-lv for Latvia
+    lt-lt for Lithuania
+    xl-es for Latin America
+    my-ms for Malaysia
+    my-en for Malaysia (en)
+    mx-es for Mexico
+    nl-nl for Netherlands
+    nz-en for New Zealand
+    no-no for Norway
+    pe-es for Peru
+    ph-en for Philippines
+    ph-tl for Philippines (tl)
+    pl-pl for Poland
+    pt-pt for Portugal
+    ro-ro for Romania
+    ru-ru for Russia
+    sg-en for Singapore
+    sk-sk for Slovak Republic
+    sl-sl for Slovenia
+    za-en for South Africa
+    es-es for Spain
+    se-sv for Sweden
+    ch-de for Switzerland (de)
+    ch-fr for Switzerland (fr)
+    ch-it for Switzerland (it)
+    tw-tzh for Taiwan
+    th-th for Thailand
+    tr-tr for Turkey
+    ua-uk for Ukraine
+    uk-en for United Kingdom
+    us-en for United States
+    ue-es for United States (es)
+    ve-es for Venezuela
+    vn-vi for Vietnam
+    wt-wt for No region
+___
+</details>
+
+[Go To TOP](#TOP)
+
+
+## WEBS and AsyncWEBS classes
+
+The WEBS and AsyncWEBS classes are used to retrieve search results from DuckDuckGo.com and yep.com periodically.
+To use the AsyncWEBS class, you can perform asynchronous operations using Python's asyncio library.
+To initialize an instance of the WEBS or AsyncWEBS classes, you can provide the following optional arguments:
+
+Here is an example of initializing the WEBS class:
+```python3
+from webscout import WEBS
+
+# Instantiating the WEBS class from webscout module
+WEBS_instance = WEBS()
+
+# Fetching text results for the query "python programming" with a maximum of 5 results
+results = [result for result in WEBS_instance.text("python programming", max_results=5)]
+
+# Displaying the obtained results
+print(results)
+```
+Here is an example of initializing the AsyncWEBS class:
+```python3
+import asyncio
+import logging
+import sys
+from itertools import chain
+from random import shuffle
+
+import requests
+from webscout import AsyncWEBS
+
+# bypass curl-cffi NotImplementedError in windows https://curl-cffi.readthedocs.io/en/latest/faq/
+if sys.platform.lower().startswith("win"):
+    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
+
+def get_words():
+    word_site = "https://www.mit.edu/~ecprice/wordlist.10000"
+    resp = requests.get(word_site)
+    words = resp.text.splitlines()
+    return words
+
+async def aget_results(word):
+    async with AsyncWEBS(proxies=proxies) as WEBS:
+        results = [r async for r in WEBS.text(word, max_results=None)]
+        return results
+
+async def main():
+    words = get_words()
+    shuffle(words)
+    tasks = []
+    for word in words[:10]:
+        tasks.append(aget_results(word))
+    results = await asyncio.gather(*tasks)
+    print(f"Done")
+    for r in chain.from_iterable(results):
+        print(r)
+    
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.DEBUG)
+    asyncio.run(main())
+```
+It is important to note that the WEBS and AsyncWEBS classes should always be used as a context manager (with statement).
+This ensures proper resource management and cleanup, as the context manager will automatically handle opening and closing the HTTP client connection.
+
+## Exceptions
+
+Exceptions:
+- `WebscoutE`: Raised when there is a generic exception during the API request.
+
+## usage
+Here are the rewritten Python scripts for accessing various functionalities using the WEBS class from the webscout module, in HelpingAI style, for DuckDuckGo.com and Yep.com without explicitly specifying the search engine:
+
+### 1. `text()` - text search by DuckDuckGo.com and Yep.com
+
+```python
+from webscout import WEBS
+
+# Text search for 'live free or die' using DuckDuckGo.com and Yep.com
+with WEBS() as WEBS:
+    for r in WEBS.text('live free or die', region='wt-wt', safesearch='off', timelimit='y', max_results=10):
+        print(r)
+
+    for r in WEBS.text('live free or die', region='wt-wt', safesearch='off', timelimit='y', max_results=10):
+        print(r)
+```
+
+### 2. `answers()` - instant answers by DuckDuckGo.com and Yep.com
+
+```python
+from webscout import WEBS
+
+# Instant answers for the query "sun" using DuckDuckGo.com and Yep.com
+with WEBS() as WEBS:
+    for r in WEBS.answers("sun"):
+        print(r)
+```
+
+### 3. `images()` - image search by DuckDuckGo.com and Yep.com
+
+```python
+from webscout import WEBS
+
+# Image search for the keyword 'butterfly' using DuckDuckGo.com and Yep.com
+with WEBS() as WEBS:
+    keywords = 'butterfly'
+    WEBS_images_gen = WEBS.images(
+      keywords,
+      region="wt-wt",
+      safesearch="off",
+      size=None,
+      color="Monochrome",
+      type_image=None,
+      layout=None,
+      license_image=None,
+      max_results=100,
+    )
+    for r in WEBS_images_gen:
+        print(r)
+```
+
+### 4. `videos()` - video search by DuckDuckGo.com 
+
+```python
+from webscout import WEBS
+
+# Video search for the keyword 'tesla' using DuckDuckGo.com 
+with WEBS() as WEBS:
+    keywords = 'tesla'
+    WEBS_videos_gen = WEBS.videos(
+      keywords,
+      region="wt-wt",
+      safesearch="off",
+      timelimit="w",
+      resolution="high",
+      duration="medium",
+      max_results=100,
+    )
+    for r in WEBS_videos_gen:
+        print(r)
+```
+
+### 5. `news()` - news search by DuckDuckGo.com and yep.com
+
+```python
+from webscout import WEBS
+
+# News search for the keyword 'holiday' using DuckDuckGo.com and yep.com
+with WEBS() as WEBS:
+    keywords = 'holiday'
+    WEBS_news_gen = WEBS.news(
+      keywords,
+      region="wt-wt",
+      safesearch="off",
+      timelimit="m",
+      max_results=20
+    )
+    for r in WEBS_news_gen:
+        print(r)
+```
+
+### 6. `maps()` - map search by DuckDuckGo.com and
+
+```python
+from webscout import WEBS
+
+# Map search for the keyword 'school' in 'anantnag' using DuckDuckGo.com
+with WEBS() as WEBS:
+    for r in WEBS.maps("school", place="anantnag", max_results=50):
+        print(r)
+```
+
+### 7. `translate()` - translation by DuckDuckGo.com and Yep.com
+
+```python
+from webscout import WEBS
+
+# Translation of the keyword 'school' to German ('hi') using DuckDuckGo.com and Yep.com
+with WEBS() as WEBS:
+    keywords = 'school'
+    r = WEBS.translate(keywords, to="hi")
+    print(r)
+```
+
+### 8. `suggestions()` - suggestions by DuckDuckGo.com and Yep.com
+
+```python
+from webscout import WEBS
+
+# Suggestions for the keyword 'fly' using DuckDuckGo.com and Yep
+# 
+
+.com
+with WEBS() as WEBS:
+    for r in WEBS.suggestions("fly"):
+        print(r)
+```
+
+### 9. `PhindSearch` - Search using Phind.com 
+Thanks to Empyros for PhindSearch function
+```python
+from webscout.AI import PhindSearch
+
+query = 'Webscout pypi'
+
+# Create an instance of WEBSAI with the query
+WEBSAI = PhindSearch(query)
+
+WEBSAI.search()
+```
+### 10. `YepChat` - Chat with mistral 8x7b powered by yepchat
+Thanks To Divyansh Shukla for This code
+```python
+from webscout.AI import YepChat
+
+def main():
+    # Initialize the YepChat class with your message
+    yep_chat = YepChat(message="who is pm of india")
+    
+    # Send the request and process the response
+    response = yep_chat.send_request()
+    processed_response = yep_chat.process_response(response)
+    
+    # Print the processed response
+    print(processed_response)
+
+if __name__ == "__main__":
+    main()
+```
+
+### 11. `You.com` - search with you.com
+```python
+from webscout.AI import youChat
+
+# Instantiate the youchat class
+youChat = youChat()
+
+while True:
+    # Ask the user for a prompt
+    prompt = input("💡 Enter a prompt (or type 'exit' to quit): ")
+    
+    # Exit condition
+    if prompt.lower() == 'exit':
+        break
+    
+    # Generate a completion based on the prompt
+    try:
+        completion = youChat.create(prompt)
+        print("💬:", completion)
+    except Exception as e:
+        print("⚠️ An error occurred:", e)
+```
+
+### 12. `Gemini` - search with google gemini
+
+```python
+from webscout.AI import Gemini
+
+# Create an instance of the Gemini class
+gemini = Gemini()
+
+# Use the chat method to send a message to the Gemini assistant
+response = gemini.chat("Your message here")
+
+# Print the response from the Gemini assistant
+print(response)
+```
+
+## Version History
+
+### v1.0.7
+- Added gemini as webscout.AI
+
+### v1.0.6
+- Added yep.com as a search engine
+- Fixed an error related to translation functionality
+- Introduced Phind AI as webscout.AI
+- Included YepChat as webscout.AI
+- Integrated You.com as webscout.AI