tavily-python 0.2.2__tar.gz → 0.2.4__tar.gz

{tavily-python-0.2.2 → tavily-python-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tavily-python
-Version: 0.2.2
+Version: 0.2.4
 Summary: Python wrapper for the Tavily API
 Home-page: https://github.com/assafelovic/tavily-python
 Author: Assaf Elovic
@@ -29,8 +29,8 @@ Usage
 
 .. code-block:: python
 
-    from tavily import Client
-    tavily = Client(api_key="YOUR_API_KEY")
+    from tavily import TavilyClient
+    tavily = TavilyClient(api_key="YOUR_API_KEY")
     # For basic search:
     tavily.search(query="Should I invest in Apple right now?")
     # For advanced search:
@@ -58,9 +58,8 @@ The ``Client`` class is the entry point to interacting with the Tavily API. Kick
 Methods
 ~~~~~~~
 
-- ``search(query, search_depth, **kwargs)``: Performs a search using the specified query. The depth of the search can be controlled by the `search_depth` parameter.
-- ``get_search_context(query, search_depth, max_tokens, **kwargs)``: Performs a search and returns a string of content and sources within token limit. Useful for getting only related content from retrieved websites
-        without having to deal with context extraction and token management.
+- ``search(query, search_depth, **kwargs)``: Performs a search using the specified query. The depth of the search can be controlled by the ``search_depth`` parameter.
+- ``get_search_context(query, search_depth, max_tokens, **kwargs)``: Performs a search and returns a string of content and sources within token limit. Useful for getting only related content from retrieved websites without having to deal with context extraction and token management.
 - ``qna_search(query, **kwargs)``: Performs a search and returns a string containing an answer to the original query including relevant sources. Optimal to be used as a tool for AI agents.
 
 Keyword Arguments
@@ -72,6 +71,7 @@ Keyword Arguments
 - ``exclude_domains`` (list): A list of domains to specifically exclude from the search results. Default is None, which doesn't exclude any domains.
 - ``include_answer`` (bool): Whether or not to include answers in the search results. Default is False.
 - ``include_raw_content`` (bool): Whether or not to include raw content in the search results. Default is False.
+- ``include_images`` (bool): Whether or not to include images in the search results. Default is False.
 
 Both methods internally call the ``_search`` method to communicate with the API.
 

{tavily-python-0.2.2 → tavily-python-0.2.4}/README.rst

@@ -16,8 +16,8 @@ Usage
 
 .. code-block:: python
 
-    from tavily import Client
-    tavily = Client(api_key="YOUR_API_KEY")
+    from tavily import TavilyClient
+    tavily = TavilyClient(api_key="YOUR_API_KEY")
     # For basic search:
     tavily.search(query="Should I invest in Apple right now?")
     # For advanced search:
@@ -45,9 +45,8 @@ The ``Client`` class is the entry point to interacting with the Tavily API. Kick
 Methods
 ~~~~~~~
 
-- ``search(query, search_depth, **kwargs)``: Performs a search using the specified query. The depth of the search can be controlled by the `search_depth` parameter.
-- ``get_search_context(query, search_depth, max_tokens, **kwargs)``: Performs a search and returns a string of content and sources within token limit. Useful for getting only related content from retrieved websites
-        without having to deal with context extraction and token management.
+- ``search(query, search_depth, **kwargs)``: Performs a search using the specified query. The depth of the search can be controlled by the ``search_depth`` parameter.
+- ``get_search_context(query, search_depth, max_tokens, **kwargs)``: Performs a search and returns a string of content and sources within token limit. Useful for getting only related content from retrieved websites without having to deal with context extraction and token management.
 - ``qna_search(query, **kwargs)``: Performs a search and returns a string containing an answer to the original query including relevant sources. Optimal to be used as a tool for AI agents.
 
 Keyword Arguments
@@ -59,6 +58,7 @@ Keyword Arguments
 - ``exclude_domains`` (list): A list of domains to specifically exclude from the search results. Default is None, which doesn't exclude any domains.
 - ``include_answer`` (bool): Whether or not to include answers in the search results. Default is False.
 - ``include_raw_content`` (bool): Whether or not to include raw content in the search results. Default is False.
+- ``include_images`` (bool): Whether or not to include images in the search results. Default is False.
 
 Both methods internally call the ``_search`` method to communicate with the API.
 

{tavily-python-0.2.2 → tavily-python-0.2.4}/setup.py

@@ -5,7 +5,7 @@ with open('README.rst', 'r', encoding='utf-8') as f:
 
 setup(
     name='tavily-python',
-    version='0.2.2',
+    version='0.2.4',
     url='https://github.com/assafelovic/tavily-python',
     author='Assaf Elovic',
     author_email='assaf.elovic@gmail.com',

tavily-python-0.2.4/tavily/__init__.py

@@ -0,0 +1,2 @@
+from .tavily import TavilyClient
+from .tavily import Client

{tavily-python-0.2.2 → tavily-python-0.2.4}/tavily/tavily.py

@@ -1,14 +1,14 @@
 import requests
 import json
+import warnings
 from .utils import get_max_items_from_list
 
-class Client:
+class TavilyClient:
     def __init__(self, api_key):
         self.base_url = "https://api.tavily.com/search"
         self.api_key = api_key
         self.headers = {
             "Content-Type": "application/json",
-            # any other headers you want
         }
 
     def _search(self, query, search_depth="basic", max_results=10,
@@ -61,3 +61,8 @@ class Client:
         """
         search_result = self._search(query, search_depth=search_depth, include_answer=True, **kwargs)
         return search_result.get("answer", "")
+
+class Client(TavilyClient):
+    def __init__(self, *args, **kwargs):
+        warnings.warn("Client is deprecated, please use TavilyClient instead", DeprecationWarning, stacklevel=2)
+        super().__init__(*args, **kwargs)

{tavily-python-0.2.2 → tavily-python-0.2.4}/tavily_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tavily-python
-Version: 0.2.2
+Version: 0.2.4
 Summary: Python wrapper for the Tavily API
 Home-page: https://github.com/assafelovic/tavily-python
 Author: Assaf Elovic
@@ -29,8 +29,8 @@ Usage
 
 .. code-block:: python
 
-    from tavily import Client
-    tavily = Client(api_key="YOUR_API_KEY")
+    from tavily import TavilyClient
+    tavily = TavilyClient(api_key="YOUR_API_KEY")
     # For basic search:
     tavily.search(query="Should I invest in Apple right now?")
     # For advanced search:
@@ -58,9 +58,8 @@ The ``Client`` class is the entry point to interacting with the Tavily API. Kick
 Methods
 ~~~~~~~
 
-- ``search(query, search_depth, **kwargs)``: Performs a search using the specified query. The depth of the search can be controlled by the `search_depth` parameter.
-- ``get_search_context(query, search_depth, max_tokens, **kwargs)``: Performs a search and returns a string of content and sources within token limit. Useful for getting only related content from retrieved websites
-        without having to deal with context extraction and token management.
+- ``search(query, search_depth, **kwargs)``: Performs a search using the specified query. The depth of the search can be controlled by the ``search_depth`` parameter.
+- ``get_search_context(query, search_depth, max_tokens, **kwargs)``: Performs a search and returns a string of content and sources within token limit. Useful for getting only related content from retrieved websites without having to deal with context extraction and token management.
 - ``qna_search(query, **kwargs)``: Performs a search and returns a string containing an answer to the original query including relevant sources. Optimal to be used as a tool for AI agents.
 
 Keyword Arguments
@@ -72,6 +71,7 @@ Keyword Arguments
 - ``exclude_domains`` (list): A list of domains to specifically exclude from the search results. Default is None, which doesn't exclude any domains.
 - ``include_answer`` (bool): Whether or not to include answers in the search results. Default is False.
 - ``include_raw_content`` (bool): Whether or not to include raw content in the search results. Default is False.
+- ``include_images`` (bool): Whether or not to include images in the search results. Default is False.
 
 Both methods internally call the ``_search`` method to communicate with the API.
 

tavily-python-0.2.2/tavily/__init__.py

@@ -1 +0,0 @@
-from .tavily import Client