webscout 6.5__py3-none-any.whl → 6.7__py3-none-any.whl

webscout/cli.py

@@ -54,7 +54,7 @@ def _print_data(data):
     console = Console()
     if data:
         for i, e in enumerate(data, start=1):
-            table = Table(show_header=False, show_lines=True, expand=True, box=None)  # Removed duplicate title
+            table = Table(show_header=False, show_lines=True, expand=True, box=None)
             table.add_column("Key", style="cyan", no_wrap=True, width=15)
             table.add_column("Value", style="white")
 
@@ -62,15 +62,14 @@ def _print_data(data):
                 if v:
                     width = 300 if k in ("content", "href", "image", "source", "thumbnail", "url") else 78
                     k = "language" if k == "detected_language" else k
-                    text = Text(f"{v}", style="white")
-                    text = text.wrap(width=width, initial_indent="", subsequent_indent=" " * 18, preserve_paragraphs=True)
+                    text = Text(str(v), style="white")
+                    text = text.wrap(width=width, console=console)
                 else:
-                    text = Text(v, style="white")
+                    text = Text(str(v), style="white")
                 table.add_row(k, text)
 
-            # Only the Panel has the title now
             console.print(Panel(table, title=f"Result {i}", expand=False, style="green on black"))
-            console.print("\n") 
+            console.print("\n")
 
 # Initialize CLI app
 app = CLI(name="webscout", help="Search the web with a rich UI", version=__version__)
@@ -117,7 +116,7 @@ def chat(proxy: str = None, model: str = "gpt-4o-mini"):
     console.print("\n[cyan]Chat session ended. Goodbye![/]")
 
 @app.command()
-@option("--keywords", "-k", help="Search keywords")
+@option("--keywords", "-k", help="Search keywords", required=True)
 @option("--region", "-r", help="Region for search results", default="wt-wt")
 @option("--safesearch", "-s", help="SafeSearch setting", default="moderate")
 @option("--timelimit", "-t", help="Time limit for results", default=None)
@@ -128,29 +127,27 @@ def text(keywords: str, region: str, safesearch: str, timelimit: str, backend: s
     """Perform a text search using DuckDuckGo API."""
     webs = WEBS(proxy=proxy)
     try:
-        webs.text(keywords, region, safesearch, timelimit, backend, max_results)
+        results = webs.text(keywords, region, safesearch, timelimit, backend, max_results)
+        _print_data(results)
     except Exception as e:
         logger.error(f"Error in text search: {e}")
         raise e
 
 @app.command()
-@option("--keywords", "-k", help="Search keywords")
-@option("--region", "-r", help="Region for search results", default="wt-wt")
-@option("--safesearch", "-s", help="SafeSearch setting", default="moderate")
-@option("--timelimit", "-t", help="Time limit for results", default=None)
-@option("--max-results", "-m", help="Maximum number of results", type=int, default=25)
+@option("--keywords", "-k", help="Search keywords", required=True)
 @option("--proxy", "-p", help="Proxy URL to use for requests")
-def answers(keywords: str, region: str, safesearch: str, timelimit: str, max_results: int, proxy: str = None):
+def answers(keywords: str, proxy: str = None):
     """Perform an answers search using DuckDuckGo API."""
     webs = WEBS(proxy=proxy)
     try:
-        webs.answers(keywords, region, safesearch, timelimit, max_results)
+        results = webs.answers(keywords)
+        _print_data(results)
     except Exception as e:
         logger.error(f"Error in answers search: {e}")
         raise e
 
 @app.command()
-@option("--keywords", "-k", help="Search keywords")
+@option("--keywords", "-k", help="Search keywords", required=True)
 @option("--region", "-r", help="Region for search results", default="wt-wt")
 @option("--safesearch", "-s", help="SafeSearch setting", default="moderate")
 @option("--timelimit", "-t", help="Time limit for results", default=None)
@@ -177,13 +174,14 @@ def images(
     """Perform an images search using DuckDuckGo API."""
     webs = WEBS(proxy=proxy)
     try:
-        webs.images(keywords, region, safesearch, timelimit, size, color, type, layout, license, max_results)
+        results = webs.images(keywords, region, safesearch, timelimit, size, color, type, layout, license, max_results)
+        _print_data(results)
     except Exception as e:
         logger.error(f"Error in images search: {e}")
         raise e
 
 @app.command()
-@option("--keywords", "-k", help="Search keywords")
+@option("--keywords", "-k", help="Search keywords", required=True)
 @option("--region", "-r", help="Region for search results", default="wt-wt")
 @option("--safesearch", "-s", help="SafeSearch setting", default="moderate")
 @option("--timelimit", "-t", help="Time limit for results", default=None)
@@ -206,13 +204,14 @@ def videos(
     """Perform a videos search using DuckDuckGo API."""
     webs = WEBS(proxy=proxy)
     try:
-        webs.videos(keywords, region, safesearch, timelimit, resolution, duration, license, max_results)
+        results = webs.videos(keywords, region, safesearch, timelimit, resolution, duration, license, max_results)
+        _print_data(results)
     except Exception as e:
         logger.error(f"Error in videos search: {e}")
         raise e
 
 @app.command()
-@option("--keywords", "-k", help="Search keywords")
+@option("--keywords", "-k", help="Search keywords", required=True)
 @option("--region", "-r", help="Region for search results", default="wt-wt")
 @option("--safesearch", "-s", help="SafeSearch setting", default="moderate")
 @option("--timelimit", "-t", help="Time limit for results", default=None)
@@ -222,13 +221,14 @@ def news(keywords: str, region: str, safesearch: str, timelimit: str, max_result
     """Perform a news search using DuckDuckGo API."""
     webs = WEBS(proxy=proxy)
     try:
-        webs.news(keywords, region, safesearch, timelimit, max_results)
+        results = webs.news(keywords, region, safesearch, timelimit, max_results)
+        _print_data(results)
     except Exception as e:
         logger.error(f"Error in news search: {e}")
         raise e
 
 @app.command()
-@option("--keywords", "-k", help="Search keywords")
+@option("--keywords", "-k", help="Search keywords", required=True)
 @option("--place", "-p", help="Simplified search - if set, the other parameters are not used")
 @option("--street", "-s", help="House number/street")
 @option("--city", "-c", help="City of search")
@@ -259,7 +259,7 @@ def maps(
     """Perform a maps search using DuckDuckGo API."""
     webs = WEBS(proxy=proxy)
     try:
-        webs.maps(
+        results = webs.maps(
             keywords,
             place,
             street,
@@ -273,12 +273,13 @@ def maps(
             radius,
             max_results,
         )
+        _print_data(results)
     except Exception as e:
         logger.error(f"Error in maps search: {e}")
         raise e
 
 @app.command()
-@option("--keywords", "-k", help="Text for translation")
+@option("--keywords", "-k", help="Text for translation", required=True)
 @option("--from", "-f", help="Language to translate from (defaults automatically)")
 @option("--to", "-t", help="Language to translate to (default: 'en')", default="en")
 @option("--proxy", "-p", help="Proxy URL to use for requests")
@@ -286,35 +287,26 @@ def translate(keywords: str, from_: str, to: str, proxy: str = None):
     """Perform translation using DuckDuckGo API."""
     webs = WEBS(proxy=proxy)
     try:
-        webs.translate(keywords, from_, to)
+        results = webs.translate(keywords, from_, to)
+        _print_data(results)
     except Exception as e:
         logger.error(f"Error in translation: {e}")
         raise e
 
 @app.command()
-@option("--keywords", "-k", help="Search keywords")
+@option("--keywords", "-k", help="Search keywords", required=True)
 @option("--region", "-r", help="Region for search results", default="wt-wt")
 @option("--proxy", "-p", help="Proxy URL to use for requests")
 def suggestions(keywords: str, region: str, proxy: str = None):
     """Perform a suggestions search using DuckDuckGo API."""
     webs = WEBS(proxy=proxy)
     try:
-        webs.suggestions(keywords, region)
+        results = webs.suggestions(keywords, region)
+        _print_data(results)
     except Exception as e:
         logger.error(f"Error in suggestions search: {e}")
         raise e
 
-@app.command()
-@option("--proxy", help="Proxy URL to use for requests")
-def interactive(proxy: str = None):
-    """Start an interactive search session with AI-powered responses."""
-    webs = WEBS(proxy=proxy)
-    try:
-        webs.interactive()
-    except Exception as e:
-        logger.error(f"Error in interactive mode: {e}")
-        raise e
-
 def main():
     """Main entry point for the CLI."""
     try:
@@ -324,4 +316,4 @@ def main():
         sys.exit(1)
 
 if __name__ == "__main__":
-    main()
+    main()

webscout/conversation.py

@@ -1,11 +1,3 @@
-"""
->>> from conversation import Conversation
->>> chat = Conversation(max_tokens=500)
->>> chat.add_message("user", "Hello!")
->>> chat.add_message("llm", "Hi there!")
->>> prompt = chat.gen_complete_prompt("What's up?")
-"""
-
 import os
 import logging
 from typing import Optional
@@ -159,7 +151,9 @@ class Conversation:
             "user": prompt,
             "llm": ""
         }
-        return intro + self.__trim_chat_history(incomplete_chat_history, intro)
+        complete_prompt = intro + self.__trim_chat_history(incomplete_chat_history, intro)
+        # logger.info(f"Generated prompt: {complete_prompt}")
+        return complete_prompt
 
     def update_chat_history(
         self, prompt: str, response: str, force: bool = False
@@ -196,6 +190,7 @@ class Conversation:
                 fh.write(new_history)
         
         self.chat_history += new_history
+        # logger.info(f"Chat history updated with prompt: {prompt}")
 
     def add_message(self, role: str, content: str) -> None:
         """Add a new message to the chat - simple and clean! 
@@ -214,6 +209,9 @@ class Conversation:
             >>> chat.add_message("user", "Hey there!")
             >>> chat.add_message("llm", "Hi! How can I help?")
         """
+        if not self.validate_message(role, content):
+            raise ValueError("Invalid message role or content")
+
         role_formats = {
             "user": "User",
             "llm": "LLM",
@@ -225,3 +223,20 @@ class Conversation:
             self.chat_history += f"\n{role_formats[role]} : {content}"
         else:
             logger.warning(f"Unknown role '{role}' for message: {content}")
+
+    #     # Enhanced logging for message addition
+    #     logger.info(f"Added message from {role}: {content}")
+    #     logging.info(f"Message added: {role}: {content}")
+
+    # def validate_message(self, role: str, content: str) -> bool:
+    #     """Validate the message role and content."""
+    #     valid_roles = {'user', 'llm', 'tool', 'reasoning'}
+    #     if role not in valid_roles:
+    #         logger.error(f"Invalid role: {role}")
+    #         return False
+    #     if not content:
+    #         logger.error("Content cannot be empty.")
+    #         return False
+    #     return True
+
+

webscout/exceptions.py

@@ -1,48 +1,117 @@
+WATCH_URL = 'https://www.youtube.com/watch?v={video_id}'
+
+
 class WebscoutE(Exception):
-    """Base exception class for search."""
+    """
+    Base exception class for all Webscout related errors.
+
+    This class serves as the root for all custom exceptions raised by the Webscout library.
+    It provides a common base for catching and handling errors specific to Webscout.
+    """
+    pass
 
 
 class APIConnectionError(Exception):
-    """Raised when there are connection issues with an API."""
+    """
+    Exception raised when there are issues connecting to an API.
+
+    This exception is raised when a network connection to an external API fails.
+    It indicates a problem with the network or the API server itself.
+    """
     pass
 
 
 class RatelimitE(Exception):
-    """Raised for rate limit exceeded errors during API requests."""
+    """
+    Exception raised when an API rate limit is exceeded.
+
+    This exception is raised when the number of requests to an API exceeds the allowed limit within a given time frame.
+    It indicates that the application is making too many requests and needs to slow down.
+    """
+    pass
 
 
 class ConversationLimitException(Exception):
-    """Raised for conversation limit exceeded errors during API requests."""
+    """
+    Exception raised when a conversation limit is exceeded.
+
+    This exception is raised when a limit on the number of turns or messages in a conversation is exceeded.
+    It indicates that the conversation has reached its maximum allowed length.
+    """
     pass
 
 
 class TimeoutE(Exception):
-    """Raised for timeout errors during API requests."""
+    """
+    Exception raised when a request to an API times out.
+
+    This exception is raised when a request to an API takes longer than the allowed time to complete.
+    It indicates a problem with the network or the API server being slow to respond.
+    """
+    pass
 
 
 class FailedToGenerateResponseError(Exception):
-    """Provider failed to fetch response"""
+    """
+    Exception raised when a provider fails to generate a response.
+
+    This exception is raised when a provider is unable to generate a response for a given request.
+    It indicates an issue with the provider's logic or data.
+    """
+    pass
 
 
 class AllProvidersFailure(Exception):
-    """None of the providers generated response successfully"""
+    """
+    Exception raised when all providers fail to generate a response.
+
+    This exception is raised when none of the available providers are able to generate a response for a given request.
+    It indicates a widespread issue with all providers.
+    """
     pass
 
 
 class FacebookInvalidCredentialsException(Exception):
+    """
+    Exception raised when Facebook credentials are invalid.
+
+    This exception is raised when the provided Facebook credentials (e.g., username, password, cookies) are invalid.
+    It indicates that the application is unable to authenticate with Facebook.
+    """
     pass
 
 
 class FacebookRegionBlocked(Exception):
+    """
+    Exception raised when Facebook access is blocked due to region restrictions.
+
+    This exception is raised when access to Facebook is blocked due to geographical restrictions.
+    It indicates that the application is unable to access Facebook from the current location.
+    """
     pass
 
 
 class ModelUnloadedException(Exception):
+    """
+    Exception raised when a model is unloaded.
+
+    This exception is raised when a required model is not loaded or has been unloaded.
+    It indicates that the application is unable to perform operations that require the model.
+    """
     pass
 
 
 class TranscriptRetrievalError(WebscoutE):
-    """Base class for transcript retrieval errors."""
+    """
+    Base class for transcript retrieval errors.
+
+    This class serves as the root for all custom exceptions related to transcript retrieval.
+    It provides a common base for catching and handling errors specific to transcript retrieval.
+
+    Args:
+        video_id (str): The ID of the video for which the transcript retrieval failed.
+        message (str): A message describing the error.
+    """
 
     def __init__(self, video_id, message):
         super().__init__(message.format(video_url=WATCH_URL.format(video_id=video_id)))
@@ -50,7 +119,16 @@ class TranscriptRetrievalError(WebscoutE):
 
 
 class YouTubeRequestFailedError(TranscriptRetrievalError):
-    """Raised when a request to YouTube fails."""
+    """
+    Exception raised when a request to YouTube fails.
+
+    This exception is raised when a network request to YouTube fails.
+    It indicates a problem with the network or the YouTube server itself.
+
+    Args:
+        video_id (str): The ID of the video for which the request failed.
+        http_error (str): The HTTP error that occurred.
+    """
 
     def __init__(self, video_id, http_error):
         message = 'Request to YouTube failed: {reason}'
@@ -58,7 +136,15 @@ class YouTubeRequestFailedError(TranscriptRetrievalError):
 
 
 class VideoUnavailableError(TranscriptRetrievalError):
-    """Raised when the video is unavailable."""
+    """
+    Exception raised when the video is unavailable.
+
+    This exception is raised when the requested video is no longer available on YouTube.
+    It indicates that the video has been removed or made private.
+
+    Args:
+        video_id (str): The ID of the unavailable video.
+    """
 
     def __init__(self, video_id):
         message = 'The video is no longer available'
@@ -66,7 +152,15 @@ class VideoUnavailableError(TranscriptRetrievalError):
 
 
 class InvalidVideoIdError(TranscriptRetrievalError):
-    """Raised when an invalid video ID is provided."""
+    """
+    Exception raised when an invalid video ID is provided.
+
+    This exception is raised when the provided video ID is not in the correct format.
+    It indicates that the application is using a URL instead of the video ID.
+
+    Args:
+        video_id (str): The invalid video ID.
+    """
 
     def __init__(self, video_id):
         message = (
@@ -78,7 +172,15 @@ class InvalidVideoIdError(TranscriptRetrievalError):
 
 
 class TooManyRequestsError(TranscriptRetrievalError):
-    """Raised when YouTube rate limits the requests."""
+    """
+    Exception raised when YouTube rate limits the requests.
+
+    This exception is raised when YouTube rate limits the requests from the current IP address.
+    It indicates that the application is making too many requests and needs to slow down or use a different IP.
+
+    Args:
+        video_id (str): The ID of the video for which the request was rate-limited.
+    """
 
     def __init__(self, video_id):
         message = (
@@ -92,7 +194,15 @@ class TooManyRequestsError(TranscriptRetrievalError):
 
 
 class TranscriptsDisabledError(TranscriptRetrievalError):
-    """Raised when transcripts are disabled for the video."""
+    """
+    Exception raised when transcripts are disabled for the video.
+
+    This exception is raised when the video has subtitles disabled.
+    It indicates that the application cannot retrieve transcripts for this video.
+
+    Args:
+        video_id (str): The ID of the video with disabled transcripts.
+    """
 
     def __init__(self, video_id):
         message = 'Subtitles are disabled for this video'
@@ -100,7 +210,15 @@ class TranscriptsDisabledError(TranscriptRetrievalError):
 
 
 class NoTranscriptAvailableError(TranscriptRetrievalError):
-    """Raised when no transcripts are available for the video."""
+    """
+    Exception raised when no transcripts are available for the video.
+
+    This exception is raised when the video has no transcripts available.
+    It indicates that the application cannot retrieve transcripts for this video.
+
+    Args:
+        video_id (str): The ID of the video with no available transcripts.
+    """
 
     def __init__(self, video_id):
         message = 'No transcripts are available for this video'
@@ -108,7 +226,15 @@ class NoTranscriptAvailableError(TranscriptRetrievalError):
 
 
 class NotTranslatableError(TranscriptRetrievalError):
-    """Raised when the transcript is not translatable."""
+    """
+    Exception raised when the transcript is not translatable.
+
+    This exception is raised when the requested language is not translatable.
+    It indicates that the application cannot translate the transcript to the requested language.
+
+    Args:
+        video_id (str): The ID of the video with a non-translatable transcript.
+    """
 
     def __init__(self, video_id):
         message = 'The requested language is not translatable'
@@ -116,7 +242,15 @@ class NotTranslatableError(TranscriptRetrievalError):
 
 
 class TranslationLanguageNotAvailableError(TranscriptRetrievalError):
-    """Raised when the requested translation language is not available."""
+    """
+    Exception raised when the requested translation language is not available.
+
+    This exception is raised when the requested translation language is not supported for the transcript.
+    It indicates that the application cannot translate the transcript to the requested language.
+
+    Args:
+        video_id (str): The ID of the video for which the translation language is not available.
+    """
 
     def __init__(self, video_id):
         message = 'The requested translation language is not available'
@@ -124,7 +258,15 @@ class TranslationLanguageNotAvailableError(TranscriptRetrievalError):
 
 
 class CookiePathInvalidError(TranscriptRetrievalError):
-    """Raised when the cookie path is invalid."""
+    """
+    Exception raised when the cookie path is invalid.
+
+    This exception is raised when the provided cookie path is invalid.
+    It indicates that the application cannot access the cookie file.
+
+    Args:
+        video_id (str): The ID of the video for which the cookie path is invalid.
+    """
 
     def __init__(self, video_id):
         message = 'The provided cookie path is invalid'
@@ -132,7 +274,15 @@ class CookiePathInvalidError(TranscriptRetrievalError):
 
 
 class CookiesInvalidError(TranscriptRetrievalError):
-    """Raised when the provided cookies are invalid."""
+    """
+    Exception raised when the provided cookies are invalid.
+
+    This exception is raised when the provided cookies are not valid or have expired.
+    It indicates that the application cannot authenticate with YouTube using the provided cookies.
+
+    Args:
+        video_id (str): The ID of the video for which the cookies are invalid.
+    """
 
     def __init__(self, video_id):
         message = 'The cookies provided are not valid (may have expired)'
@@ -140,7 +290,15 @@ class CookiesInvalidError(TranscriptRetrievalError):
 
 
 class FailedToCreateConsentCookieError(TranscriptRetrievalError):
-    """Raised when consent cookie creation fails."""
+    """
+    Exception raised when consent cookie creation fails.
+
+    This exception is raised when the application fails to automatically give consent to saving cookies.
+    It indicates that the application cannot proceed without the consent cookie.
+
+    Args:
+        video_id (str): The ID of the video for which the consent cookie creation failed.
+    """
 
     def __init__(self, video_id):
         message = 'Failed to automatically give consent to saving cookies'
@@ -148,7 +306,17 @@ class FailedToCreateConsentCookieError(TranscriptRetrievalError):
 
 
 class NoTranscriptFoundError(TranscriptRetrievalError):
-    """Raised when no transcript is found for the requested language codes."""
+    """
+    Exception raised when no transcript is found for the requested language codes.
+
+    This exception is raised when no transcripts are found for any of the requested language codes.
+    It indicates that the application cannot retrieve transcripts for the requested languages.
+
+    Args:
+        video_id (str): The ID of the video for which no transcript was found.
+        requested_language_codes (list): The list of requested language codes.
+        transcript_data (dict): The transcript data that was found.
+    """
 
     def __init__(self, video_id, requested_language_codes, transcript_data):
         message = (