tavily-python 0.7.3__tar.gz → 0.7.5__tar.gz

{tavily_python-0.7.3 → tavily_python-0.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tavily-python
-Version: 0.7.3
+Version: 0.7.5
 Summary: Python wrapper for the Tavily API
 Home-page: https://github.com/tavily-ai/tavily-python
 Author: Tavily AI
@@ -27,6 +27,11 @@ Dynamic: summary
 
 # Tavily Python Wrapper
 
+[![GitHub stars](https://img.shields.io/github/stars/tavily-ai/tavily-python?style=social)](https://github.com/tavily-ai/tavily-python/stargazers)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/tavily-python)](https://pypi.org/project/tavily-python/)
+[![License](https://img.shields.io/github/license/tavily-ai/tavily-python)](https://github.com/tavily-ai/tavily-python/blob/main/LICENSE)
+[![CI](https://github.com/tavily-ai/tavily-python/actions/workflows/tests.yml/badge.svg)](https://github.com/tavily-ai/tavily-python/actions)
+
 The Tavily Python wrapper allows for easy interaction with the Tavily API, offering the full range of our search and extract functionalities directly from your Python programs. Easily integrate smart search and content extraction capabilities into your applications, harnessing Tavily's powerful search and extract features.
 
 ## Installing

{tavily_python-0.7.3 → tavily_python-0.7.5}/README.md

@@ -1,5 +1,10 @@
 # Tavily Python Wrapper
 
+[![GitHub stars](https://img.shields.io/github/stars/tavily-ai/tavily-python?style=social)](https://github.com/tavily-ai/tavily-python/stargazers)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/tavily-python)](https://pypi.org/project/tavily-python/)
+[![License](https://img.shields.io/github/license/tavily-ai/tavily-python)](https://github.com/tavily-ai/tavily-python/blob/main/LICENSE)
+[![CI](https://github.com/tavily-ai/tavily-python/actions/workflows/tests.yml/badge.svg)](https://github.com/tavily-ai/tavily-python/actions)
+
 The Tavily Python wrapper allows for easy interaction with the Tavily API, offering the full range of our search and extract functionalities directly from your Python programs. Easily integrate smart search and content extraction capabilities into your applications, harnessing Tavily's powerful search and extract features.
 
 ## Installing

tavily_python-0.7.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{tavily_python-0.7.3 → tavily_python-0.7.5}/setup.py

@@ -5,14 +5,14 @@ with open('README.md', 'r', encoding='utf-8') as f:
 
 setup(
     name='tavily-python',
-    version='0.7.3',
+    version='0.7.5',
     url='https://github.com/tavily-ai/tavily-python',
     author='Tavily AI',
     author_email='support@tavily.com',
     description='Python wrapper for the Tavily API',
     long_description=long_description,
     long_description_content_type='text/markdown',
-    packages=find_packages(),
+    packages=find_packages(exclude=['tests']),
     install_requires=['requests', 'tiktoken>=0.5.1', 'httpx'],
     classifiers=[
         'Programming Language :: Python :: 3',

{tavily_python-0.7.3 → tavily_python-0.7.5}/tavily/async_tavily.py

@@ -60,9 +60,10 @@ class AsyncTavilyClient:
             include_domains: Sequence[str] = None,
             exclude_domains: Sequence[str] = None,
             include_answer: Union[bool, Literal["basic", "advanced"]] = False,
-            include_raw_content: bool = False,
+            include_raw_content: Union[bool, Literal["markdown", "text"]] = False,
             include_images: bool = False,
             timeout: int = 60,
+            country: str = None,
             **kwargs,
     ) -> dict:
         """
@@ -72,7 +73,7 @@ class AsyncTavilyClient:
             "query": query,
             "search_depth": search_depth,
             "topic": topic,
-            "time_range'": time_range,
+            "time_range": time_range,
             "days": days,
             "include_answer": include_answer,
             "include_raw_content": include_raw_content,
@@ -80,6 +81,7 @@ class AsyncTavilyClient:
             "include_domains": include_domains,
             "exclude_domains": exclude_domains,
             "include_images": include_images,
+            "country": country,
         }
 
         if kwargs:
@@ -123,9 +125,10 @@ class AsyncTavilyClient:
                      include_domains: Sequence[str] = None,
                      exclude_domains: Sequence[str] = None,
                      include_answer: Union[bool, Literal["basic", "advanced"]] = False,
-                     include_raw_content: bool = False,
+                     include_raw_content: Union[bool, Literal["markdown", "text"]] = False,
                      include_images: bool = False,
                      timeout: int = 60,
+                     country: str = None,
                      **kwargs,  # Accept custom arguments
                      ) -> dict:
         """
@@ -144,6 +147,7 @@ class AsyncTavilyClient:
                                            include_raw_content=include_raw_content,
                                            include_images=include_images,
                                            timeout=timeout,
+                                           country=country,
                                            **kwargs,
                                            )
 
@@ -158,6 +162,7 @@ class AsyncTavilyClient:
             urls: Union[List[str], str],
             include_images: bool = False,
             extract_depth: Literal["basic", "advanced"] = "basic",
+            format: Literal["markdown", "text"] = "markdown",
             timeout: int = 60,
             **kwargs
     ) -> dict:
@@ -168,6 +173,7 @@ class AsyncTavilyClient:
             "urls": urls,
             "include_images": include_images,
             "extract_depth": extract_depth,
+            "format": format,
         }
         if kwargs:
             data.update(kwargs)
@@ -205,6 +211,7 @@ class AsyncTavilyClient:
                       urls: Union[List[str], str],  # Accept a list of URLs or a single URL
                       include_images: bool = False,
                       extract_depth: Literal["basic", "advanced"] = "basic",
+                      format: Literal["markdown", "text"] = "markdown",
                       timeout: int = 60,
                       **kwargs,  # Accept custom arguments
                       ) -> dict:
@@ -215,6 +222,7 @@ class AsyncTavilyClient:
         response_dict = await self._extract(urls,
                                             include_images,
                                             extract_depth,
+                                            format,
                                             timeout,
                                             **kwargs,
                                             )
@@ -241,6 +249,7 @@ class AsyncTavilyClient:
                include_images: bool = None,
                categories: Sequence[AllowedCategory] = None,
                extract_depth: Literal["basic", "advanced"] = None,
+               format: Literal["markdown", "text"] = None,
                timeout: int = 60,
                **kwargs
                ) -> dict:
@@ -261,6 +270,7 @@ class AsyncTavilyClient:
             "categories": categories,
             "include_images": include_images,
             "extract_depth": extract_depth,
+            "format": format
         }
 
         if kwargs:
@@ -310,6 +320,7 @@ class AsyncTavilyClient:
                     categories: Sequence[AllowedCategory] = None,
                     extract_depth: Literal["basic", "advanced"] = None,
                     include_images: bool = None,
+                    format: Literal["markdown", "text"] = None,
                     timeout: int = 60,
                     **kwargs
                     ) -> dict:
@@ -331,6 +342,7 @@ class AsyncTavilyClient:
                                     categories=categories,
                                     extract_depth=extract_depth,
                                     include_images=include_images,
+                                    format=format,
                                     timeout=timeout,
                                     **kwargs)
 
@@ -451,6 +463,7 @@ class AsyncTavilyClient:
                                  exclude_domains: Sequence[str] = None,
                                  max_tokens: int = 4000,
                                  timeout: int = 60,
+                                 country: str = None,
                                  **kwargs,  # Accept custom arguments
                                  ) -> str:
         """
@@ -473,6 +486,7 @@ class AsyncTavilyClient:
                                            include_raw_content=False,
                                            include_images=False,
                                            timeout = timeout,
+                                           country=country,
                                            **kwargs,
                                            )
         sources = response_dict.get("results", [])
@@ -488,6 +502,7 @@ class AsyncTavilyClient:
                          include_domains: Sequence[str] = None,
                          exclude_domains: Sequence[str] = None,
                          timeout: int = 60,
+                         country: str = None,
                          **kwargs,  # Accept custom arguments
                          ) -> str:
         """
@@ -505,6 +520,7 @@ class AsyncTavilyClient:
                                            include_images=False,
                                            include_answer=True,
                                            timeout = timeout,
+                                           country=country,
                                            **kwargs,
                                            )
         return response_dict.get("answer", "")
@@ -514,6 +530,7 @@ class AsyncTavilyClient:
                                search_depth: Literal["basic", "advanced"] = "advanced",
                                max_results: int = 5,
                                timeout: int = 60,
+                               country: str = None,
                                ) -> Sequence[dict]:
         """ Company information search method. Search depth is advanced by default to get the best answer. """
         timeout = min(timeout, 120)
@@ -524,7 +541,8 @@ class AsyncTavilyClient:
                                       topic=topic,
                                       max_results=max_results,
                                       include_answer=False,
-                                      timeout = timeout)
+                                      timeout = timeout,
+                                      country=country)
 
         all_results = []
         for data in await asyncio.gather(*[_perform_search(topic) for topic in self._company_info_tags]):

{tavily_python-0.7.3 → tavily_python-0.7.5}/tavily/config.py

@@ -10,4 +10,3 @@ AllowedCategory = Literal[
     "E-Commerce", "Authentication", "Developer", "Developers", "Solutions", 
     "Partners", "Downloads", "Media", "Events", "People"
 ]
-

{tavily_python-0.7.3 → tavily_python-0.7.5}/tavily/tavily.py

@@ -45,9 +45,10 @@ class TavilyClient:
                 include_domains: Sequence[str] = None,
                 exclude_domains: Sequence[str] = None,
                 include_answer: Union[bool, Literal["basic", "advanced"]] = False,
-                include_raw_content: bool = False,
+                include_raw_content: Union[bool, Literal["markdown", "text"]] = False,
                 include_images: bool = False,
                 timeout: int = 60,
+                country: str = None,
                 **kwargs
                 ) -> dict:
         """
@@ -66,6 +67,7 @@ class TavilyClient:
             "include_domains": include_domains,
             "exclude_domains": exclude_domains,
             "include_images": include_images,
+            "country": country,
         }
 
         if kwargs:
@@ -110,9 +112,10 @@ class TavilyClient:
                include_domains: Sequence[str] = None,
                exclude_domains: Sequence[str] = None,
                include_answer: Union[bool, Literal["basic", "advanced"]] = False,
-               include_raw_content: bool = False,
+               include_raw_content: Union[bool, Literal["markdown", "text"]] = False,
                include_images: bool = False,
                timeout: int = 60,
+               country: str = None,
                **kwargs,  # Accept custom arguments
                ) -> dict:
         """
@@ -131,6 +134,7 @@ class TavilyClient:
                                      include_raw_content=include_raw_content,
                                      include_images=include_images,
                                      timeout=timeout,
+                                     country=country,
                                      **kwargs,
                                      )
 
@@ -144,6 +148,7 @@ class TavilyClient:
                  urls: Union[List[str], str],
                  include_images: bool = False,
                  extract_depth: Literal["basic", "advanced"] = "basic",
+                 format: Literal["markdown", "text"] = "markdown",
                  timeout: int = 60,
                  **kwargs
                  ) -> dict:
@@ -154,6 +159,7 @@ class TavilyClient:
             "urls": urls,
             "include_images": include_images,
             "extract_depth": extract_depth,
+            "format": format,
         }
         if kwargs:
             data.update(kwargs)
@@ -189,6 +195,7 @@ class TavilyClient:
                 urls: Union[List[str], str],  # Accept a list of URLs or a single URL
                 include_images: bool = False,
                 extract_depth: Literal["basic", "advanced"] = "basic",
+                format: Literal["markdown", "text"] = "markdown",
                 timeout: int = 60,
                 **kwargs,  # Accept custom arguments
                 ) -> dict:
@@ -199,6 +206,7 @@ class TavilyClient:
         response_dict = self._extract(urls,
                                       include_images,
                                       extract_depth,
+                                      format,
                                       timeout,
                                       **kwargs)
 
@@ -224,6 +232,7 @@ class TavilyClient:
             include_images: bool = None,
             categories: Sequence[AllowedCategory] = None,
             extract_depth: Literal["basic", "advanced"] = None,
+            format: Literal["markdown", "text"] = None,
             timeout: int = 60,
             **kwargs
             ) -> dict:
@@ -244,6 +253,7 @@ class TavilyClient:
             "include_images": include_images,
             "categories": categories,
             "extract_depth": extract_depth,
+            "format": format
         }
 
         if kwargs:
@@ -293,6 +303,7 @@ class TavilyClient:
               include_images: bool = None,
               categories: Sequence[AllowedCategory] = None,
               extract_depth: Literal["basic", "advanced"] = None,
+              format: Literal["markdown", "text"] = None,
               timeout: int = 60,
               **kwargs
               ) -> dict:
@@ -311,9 +322,10 @@ class TavilyClient:
                                     exclude_paths=exclude_paths,
                                     exclude_domains=exclude_domains,
                                     allow_external=allow_external,
+                                    include_images=include_images,
                                     categories=categories,
                                     extract_depth=extract_depth,
-                                    include_images=include_images,
+                                    format=format,
                                     timeout=timeout,
                                     **kwargs)
 
@@ -434,6 +446,7 @@ class TavilyClient:
                            exclude_domains: Sequence[str] = None,
                            max_tokens: int = 4000,
                            timeout: int = 60,
+                           country: str = None,
                            **kwargs,  # Accept custom arguments
                            ) -> str:
         """
@@ -456,6 +469,7 @@ class TavilyClient:
                                      include_raw_content=False,
                                      include_images=False,
                                      timeout=timeout,
+                                     country=country,
                                      **kwargs,
                                      )
         sources = response_dict.get("results", [])
@@ -472,6 +486,7 @@ class TavilyClient:
                    include_domains: Sequence[str] = None,
                    exclude_domains: Sequence[str] = None,
                    timeout: int = 60,
+                   country: str = None,
                    **kwargs,  # Accept custom arguments
                    ) -> str:
         """
@@ -489,6 +504,7 @@ class TavilyClient:
                                      include_images=False,
                                      include_answer=True,
                                      timeout=timeout,
+                                     country=country,
                                      **kwargs,
                                      )
         return response_dict.get("answer", "")
@@ -499,6 +515,7 @@ class TavilyClient:
                                                "advanced"] = "advanced",
                          max_results: int = 5,
                          timeout: int = 60,
+                         country: str = None,
                          ) -> Sequence[dict]:
         """ Company information search method. Search depth is advanced by default to get the best answer. """
         timeout = min(timeout, 120)
@@ -508,7 +525,8 @@ class TavilyClient:
                                 topic=topic,
                                 max_results=max_results,
                                 include_answer=False,
-                                timeout=timeout)
+                                timeout=timeout,
+                                country=country)
 
         with ThreadPoolExecutor() as executor:
             # Initiate the search for each topic in parallel

{tavily_python-0.7.3 → tavily_python-0.7.5}/tavily_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tavily-python
-Version: 0.7.3
+Version: 0.7.5
 Summary: Python wrapper for the Tavily API
 Home-page: https://github.com/tavily-ai/tavily-python
 Author: Tavily AI
@@ -27,6 +27,11 @@ Dynamic: summary
 
 # Tavily Python Wrapper
 
+[![GitHub stars](https://img.shields.io/github/stars/tavily-ai/tavily-python?style=social)](https://github.com/tavily-ai/tavily-python/stargazers)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/tavily-python)](https://pypi.org/project/tavily-python/)
+[![License](https://img.shields.io/github/license/tavily-ai/tavily-python)](https://github.com/tavily-ai/tavily-python/blob/main/LICENSE)
+[![CI](https://github.com/tavily-ai/tavily-python/actions/workflows/tests.yml/badge.svg)](https://github.com/tavily-ai/tavily-python/actions)
+
 The Tavily Python wrapper allows for easy interaction with the Tavily API, offering the full range of our search and extract functionalities directly from your Python programs. Easily integrate smart search and content extraction capabilities into your applications, harnessing Tavily's powerful search and extract features.
 
 ## Installing

{tavily_python-0.7.3 → tavily_python-0.7.5}/tavily_python.egg-info/SOURCES.txt

@@ -1,6 +1,5 @@
 LICENSE
 README.md
-setup.cfg
 setup.py
 tavily/__init__.py
 tavily/async_tavily.py
@@ -15,5 +14,7 @@ tavily_python.egg-info/SOURCES.txt
 tavily_python.egg-info/dependency_links.txt
 tavily_python.egg-info/requires.txt
 tavily_python.egg-info/top_level.txt
-tests/test_async_search.py
-tests/test_sync_search.py
+tests/test_crawl.py
+tests/test_errors.py
+tests/test_map.py
+tests/test_search.py

tavily_python-0.7.5/tests/test_crawl.py

@@ -0,0 +1,102 @@
+import asyncio
+
+dummy_response = {
+    "base_url": "tavily.com",
+    "results": [
+        {
+            "url": "https://www.tavily.com/",
+            "raw_content": "Tavily page content",
+            "images": []
+        },
+    ],
+    "response_time": 1.5
+}
+
+def validate_default(request, response):
+    assert request.method == "POST"
+    assert request.url == "https://api.tavily.com/crawl"
+    assert request.headers["Authorization"] == "Bearer tvly-test"
+    assert request.json().get('url') == "https://tavily.com"
+    assert response == dummy_response
+
+def validate_specific(request, response):
+    assert request.method == "POST"
+    assert request.url == "https://api.tavily.com/crawl"
+    assert request.headers["Authorization"] == "Bearer tvly-test"
+    assert request.timeout == 10
+    
+    request_json = request.json()
+    for key, value in {
+        "url": "https://tavily.com",
+        "max_depth": 2,
+        "max_breadth": 3,
+        "limit": 5,
+        "instructions": "Focus on pricing pages",
+        "select_paths": ["/privacy", "/terms"],
+        "select_domains": ["tavily.com"],
+        "exclude_paths": ["/contact"],
+        "exclude_domains": ["example.com"],
+        "allow_external": False,
+        "include_images": True,
+        "categories": ["pricing", "documentation"],
+        "extract_depth": "advanced"
+    }.items():
+        assert request_json.get(key) == value
+
+    assert response == dummy_response
+
+def test_sync_crawl_defaults(sync_interceptor, sync_client):
+    sync_interceptor.set_response(200, json=dummy_response)
+    response = sync_client.crawl("https://tavily.com")
+    request = sync_interceptor.get_request()
+    validate_default(request, response)
+
+def test_sync_crawl_specific(sync_interceptor, sync_client):
+    sync_interceptor.set_response(200, json=dummy_response)
+    response = sync_client.crawl(
+        url="https://tavily.com",
+        max_depth=2,
+        max_breadth=3,
+        limit=5,
+        instructions="Focus on pricing pages",
+        select_paths=["/privacy", "/terms"],
+        select_domains=["tavily.com"],
+        exclude_paths=["/contact"],
+        exclude_domains=["example.com"],
+        allow_external=False,
+        include_images=True,
+        categories=["pricing", "documentation"],
+        extract_depth="advanced",
+        timeout=10
+    )
+
+    request = sync_interceptor.get_request()
+    validate_specific(request, response)
+
+def test_async_crawl_defaults(async_interceptor, async_client):
+    async_interceptor.set_response(200, json=dummy_response)
+    response = asyncio.run(async_client.crawl("https://tavily.com"))
+    request = async_interceptor.get_request()
+    validate_default(request, response)
+
+def test_async_crawl_specific(async_interceptor, async_client):
+    async_interceptor.set_response(200, json=dummy_response)
+    response = asyncio.run(async_client.crawl(
+        url="https://tavily.com",
+        max_depth=2,
+        max_breadth=3,
+        limit=5,
+        instructions="Focus on pricing pages",
+        select_paths=["/privacy", "/terms"],
+        select_domains=["tavily.com"],
+        exclude_paths=["/contact"],
+        exclude_domains=["example.com"],
+        allow_external=False,
+        include_images=True,
+        categories=["pricing", "documentation"],
+        extract_depth="advanced",
+        timeout=10
+    ))
+
+    request = async_interceptor.get_request()
+    validate_specific(request, response)

tavily_python-0.7.5/tests/test_errors.py

@@ -0,0 +1,50 @@
+import pytest
+import os
+import asyncio
+
+import tavily.tavily as sync_tavily
+import tavily.async_tavily as async_tavily
+from tavily.errors import MissingAPIKeyError, InvalidAPIKeyError
+
+@pytest.fixture
+def set_api_key():
+    old_key = os.getenv("TAVILY_API_KEY")
+    os.environ["TAVILY_API_KEY"] = "test_api_key"
+    yield
+    os.environ["TAVILY_API_KEY"] = old_key
+
+@pytest.fixture
+def clear_api_key():
+    old_key = os.getenv("TAVILY_API_KEY")
+    if old_key:
+        del os.environ["TAVILY_API_KEY"]
+    yield
+    if old_key:
+        os.environ["TAVILY_API_KEY"] = old_key
+
+def test_load_key_from_env(set_api_key):
+    sync_tavily.TavilyClient()
+    async_tavily.AsyncTavilyClient()
+
+    # No error should be raised
+
+def test_missing_api_key(clear_api_key):
+    with pytest.raises(MissingAPIKeyError):
+        sync_tavily.TavilyClient(api_key='')
+
+    with pytest.raises(MissingAPIKeyError):
+        async_tavily.AsyncTavilyClient(api_key='')
+
+    with pytest.raises(MissingAPIKeyError):
+        sync_tavily.TavilyClient()
+
+    with pytest.raises(MissingAPIKeyError):
+        async_tavily.AsyncTavilyClient()
+
+def test_invalid_api_key():
+    with pytest.raises(InvalidAPIKeyError):
+        sync_tavily.TavilyClient(api_key="invalid_api_key").search("What is Tavily?")
+
+    with pytest.raises(InvalidAPIKeyError):
+        print(async_tavily.httpx.AsyncClient.post)
+        print(asyncio.run(async_tavily.AsyncTavilyClient(api_key="invalid_api_key").search("What is Tavily?")))

tavily_python-0.7.5/tests/test_map.py

@@ -0,0 +1,98 @@
+import asyncio
+
+dummy_response = {
+    "base_url": "tavily.com",
+    "results": [
+        "https://www.tavily.com/",
+        "https://www.tavily.com/enterprise",
+        "https://www.tavily.com/terms",
+        "https://www.tavily.com/contact",
+    ],
+    "response_time": 0.5,
+}
+
+def validate_default(request, response):
+    assert request.method == "POST"
+    assert request.url == "https://api.tavily.com/map"
+    assert request.headers["Authorization"] == "Bearer tvly-test"
+    assert request.json().get('url') == "https://tavily.com"
+    assert response == dummy_response
+
+def validate_specific(request, response):
+    assert request.method == "POST"
+    assert request.url == "https://api.tavily.com/map"
+    assert request.headers["Authorization"] == "Bearer tvly-test"
+    assert request.timeout == 10
+    
+    request_json = request.json()
+    for key, value in {
+        "url": "https://tavily.com",
+        "max_depth": 2,
+        "max_breadth": 3,
+        "limit": 5,
+        "instructions": "Focus on navigation structure",
+        "select_paths": ["/pricing", "/docs"],
+        "select_domains": ["tavily.com"],
+        "exclude_paths": ["/blog"],
+        "exclude_domains": ["example.com"],
+        "allow_external": False,
+        "include_images": True,
+        "categories": ["pricing", "documentation"]
+    }.items():
+        assert request_json.get(key) == value
+
+    assert response == dummy_response
+
+def test_sync_map_defaults(sync_interceptor, sync_client):
+    sync_interceptor.set_response(200, json=dummy_response)
+    response = sync_client.map("https://tavily.com")
+    request = sync_interceptor.get_request()
+    validate_default(request, response)
+
+def test_sync_map_specific(sync_interceptor, sync_client):
+    sync_interceptor.set_response(200, json=dummy_response)
+    response = sync_client.map(
+        url="https://tavily.com",
+        max_depth=2,
+        max_breadth=3,
+        limit=5,
+        instructions="Focus on navigation structure",
+        select_paths=["/pricing", "/docs"],
+        select_domains=["tavily.com"],
+        exclude_paths=["/blog"],
+        exclude_domains=["example.com"],
+        allow_external=False,
+        include_images=True,
+        categories=["pricing", "documentation"],
+        timeout=10
+    )
+
+    request = sync_interceptor.get_request()
+    validate_specific(request, response)
+
+def test_async_map_defaults(async_interceptor, async_client):
+    async_interceptor.set_response(200, json=dummy_response)
+    response = asyncio.run(async_client.map("https://tavily.com"))
+    request = async_interceptor.get_request()
+    validate_default(request, response)
+
+def test_async_map_specific(async_interceptor, async_client):
+    async_interceptor.set_response(200, json=dummy_response)
+    response = asyncio.run(async_client.map(
+        url="https://tavily.com",
+        max_depth=2,
+        max_breadth=3,
+        limit=5,
+        instructions="Focus on navigation structure",
+        select_paths=["/pricing", "/docs"],
+        select_domains=["tavily.com"],
+        exclude_paths=["/blog"],
+        exclude_domains=["example.com"],
+        allow_external=False,
+        include_images=True,
+        categories=["pricing", "documentation"],
+        timeout=10
+    ))
+
+    request = async_interceptor.get_request()
+    validate_specific(request, response)

tavily_python-0.7.5/tests/test_search.py

@@ -0,0 +1,99 @@
+import asyncio
+
+dummy_response = {
+        "query": "What is Tavily?",
+        "follow_up_questions": None,
+        "answer": None,
+        "images": [],
+        "results": [
+            {
+                "title": "Tavily",
+                "url": "https://tavily.com",
+                "content": "Connect Your LLM to the Web Empowering your AI applications with " \
+                           "real-time, accurate search results tailored for LLMs and RAG.",
+                "score": 0.99,
+                "raw_content": None
+            }
+        ],
+        "response_time": 1.5
+    }
+
+def validate_default(request, response):
+    assert request.method == "POST"
+    assert request.url == "https://api.tavily.com/search"
+    assert request.headers["Authorization"] == "Bearer tvly-test"
+    assert request.json().get('query') == "What is Tavily?"
+    assert response == dummy_response
+
+def validate_specific(request, response):
+    assert request.method == "POST"
+    assert request.url == "https://api.tavily.com/search"
+    assert request.headers["Authorization"] == "Bearer tvly-test"
+    assert request.timeout == 10
+    
+    request_json = request.json()
+    for key, value in {
+        "query": "What is Tavily?",
+        "search_depth": "advanced",
+        "topic": "news",
+        "days": 5,
+        "max_results": 10,
+        "include_domains": ["tavily.com"],
+        "exclude_domains": ["example.com"],
+        "include_answer": "advanced",
+        "include_raw_content": True,
+        "include_images": True
+    }.items():
+        assert request_json.get(key) == value
+
+    assert response == dummy_response
+
+def test_sync_search_defaults(sync_interceptor, sync_client):
+    sync_interceptor.set_response(200, json=dummy_response)
+    response = sync_client.search("What is Tavily?")
+    request = sync_interceptor.get_request()
+    validate_default(request, response)
+
+def test_sync_search_specific(sync_interceptor, sync_client):
+    sync_interceptor.set_response(200, json=dummy_response)
+    response = sync_client.search(
+        "What is Tavily?",
+        search_depth="advanced",
+        topic="news",
+        days=5,
+        max_results=10,
+        include_domains=["tavily.com"],
+        exclude_domains=["example.com"],
+        include_answer="advanced",
+        include_raw_content=True,
+        include_images=True,
+        timeout=10
+    )
+
+    request = sync_interceptor.get_request()
+    validate_specific(request, response)
+
+def test_async_search_defaults(async_interceptor, async_client):
+    async_interceptor.set_response(200, json=dummy_response)
+    response = asyncio.run(async_client.search("What is Tavily?"))
+    request = async_interceptor.get_request()
+    validate_default(request, response)
+
+def test_async_search_specific(async_interceptor, async_client):
+    async_interceptor.set_response(200, json=dummy_response)
+    response = asyncio.run(async_client.search(
+        "What is Tavily?",
+        search_depth="advanced",
+        topic="news",
+        days=5,
+        max_results=10,
+        include_domains=["tavily.com"],
+        exclude_domains=["example.com"],
+        include_answer="advanced",
+        include_raw_content=True,
+        include_images=True,
+        timeout=10
+    ))
+
+    request = async_interceptor.get_request()
+    validate_specific(request, response)

tavily_python-0.7.3/setup.cfg

@@ -1,8 +0,0 @@
-[metadata]
-description_file = README.rst
-license_files = LICENSE
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

tavily_python-0.7.3/tests/test_async_search.py

@@ -1,219 +0,0 @@
-import unittest
-import os
-from tavily import AsyncTavilyClient, MissingAPIKeyError, InvalidAPIKeyError
-from urllib.parse import urlparse
-import asyncio
-
-from unit_tests import cases
-class SearchTest(unittest.TestCase):
-    
-    def setUp(self) -> None:
-        self.tavily_client = AsyncTavilyClient(api_key=os.getenv("TAVILY_API_KEY"))
-        return super().setUp()
-    
-    def tearDown(self) -> None:
-        return super().tearDown()
-    
-    # Every single search result should have these properties
-    def common_search_result_properties(self, result) -> None:
-        self.assertIsInstance(result, dict)
-        self.assertIn("title", result)
-        self.assertIn("url", result)
-        self.assertIn("content", result)
-        self.assertIn("score", result)
-
-    # General search results should have these properties
-    def general_search_result_properties(self, result) -> None:
-        self.common_search_result_properties(result)
-        self.assertIn("raw_content", result)
-
-    # News search results should have these properties
-    def news_search_result_properties(self, result) -> None:
-        self.common_search_result_properties(result)
-        self.assertIn("published_date", result)
-
-    # Topic-specific properties
-    def topic_specific_properties(self, result, **params) -> None:
-        if params.get("topic", "general") == "general":
-            self.assertIn("raw_content", result)
-        elif params.get("topic", "general") == "news":
-            self.assertIn("published_date", result)
-
-    # Domain inclusion/exclusion-dependent properties
-    def domain_dependent_properties(self, response, **params) -> None:
-        if params.get("topic", "general") != "general":
-            return
-
-        if params.get("include_domains", False) and len(params["include_domains"]) > 0:
-            for result in response["results"]:
-                self.assertTrue(any(domain in urlparse(result["url"]).netloc for domain in params["include_domains"]))
-
-        if params.get("exclude_domains", False) and len(params["exclude_domains"]) > 0:
-            for result in response["results"]:
-                self.assertFalse(any(domain in urlparse(result["url"]).netloc for domain in params["exclude_domains"]))
-
-    # Image-dependent properties
-    def image_properties(self, response, **params) -> None:
-        if params.get("topic", "general") == "general" and params.get("include_images", False):
-            self.assertIsNotNone(response["images"])
-            self.assertIsInstance(response["images"], list)
-            for image in response["images"]:
-                self.assertIsInstance(image, str)
-
-    # Answer-dependent properties
-    def answer_properties(self, response, **params) -> None:
-        if params.get("include_answer", False):
-            self.assertIn("answer", response)
-            self.assertIsInstance(response["answer"], str)
-
-
-    # Every single search response should have these properties
-    def common_response_properties(self, response) -> None:
-        self.assertIsNotNone(response)
-        self.assertIsInstance(response, dict)
-        self.assertIn("answer", response)
-        self.assertIn("query", response)
-        self.assertIn("results", response)
-        self.assertIn("images", response)
-        self.assertIn("response_time", response)
-        self.assertIn("follow_up_questions", response)
-
-        self.assertIsNotNone(response["query"])
-        self.assertIsNotNone(response["results"])
-        self.assertIsNotNone(response["response_time"])
-        self.assertIsNotNone(response["images"])
-
-        self.assertIsInstance(response["query"], str)
-        self.assertIsInstance(response["results"], list)
-        self.assertIsInstance(response["response_time"], float)
-        self.assertIsInstance(response["images"], list)
-
-    # Search responses also have properties that depend on the request params
-    def custom_response_properties(self, response, **params) -> None:
-        self.domain_dependent_properties(response, **params)
-        self.image_properties(response, **params)
-        self.answer_properties(response, **params)
-        for result in response["results"]:
-            self.topic_specific_properties(result, **params)
-
-    def test_internal_search(self) -> None:
-        for test_case in cases:
-            with self.subTest(msg=test_case["name"]):
-                response = asyncio.run(self.tavily_client._search(**test_case["params"]))
-                self.common_response_properties(response)
-                if test_case["params"].get("topic", "general") == "general":
-                    for search_result in response["results"]:
-                        self.general_search_result_properties(search_result)
-                elif test_case["params"].get("topic", "general") == "news":
-                    for search_result in response["results"]:
-                        self.news_search_result_properties(search_result)
-                self.custom_response_properties(response, **test_case["params"])
-
-    def test_external_search(self) -> None:
-        for test_case in cases:
-            with self.subTest(msg=test_case["name"]):
-                response = asyncio.run(self.tavily_client.search(**test_case["params"]))
-                self.common_response_properties(response)
-                if test_case["params"].get("topic", "general") == "general":
-                    for search_result in response["results"]:
-                        self.general_search_result_properties(search_result)
-                elif test_case["params"].get("topic", "general") == "news":
-                    for search_result in response["results"]:
-                        self.news_search_result_properties(search_result)
-                self.custom_response_properties(response, **test_case["params"])
-
-class QNASearchTest(unittest.TestCase):
-    
-    def setUp(self) -> None:
-        self.tavily_client = AsyncTavilyClient(api_key=os.getenv("TAVILY_API_KEY"))
-        return super().setUp()
-    
-    def tearDown(self) -> None:
-        return super().tearDown()
-    
-    def test_qna_search(self) -> None:
-        for test_case in cases:
-            if "include_answer" in test_case["params"]:
-                del test_case["params"]["include_answer"]
-            if "include_raw_content" in test_case["params"]:
-                del test_case["params"]["include_raw_content"]
-            if "include_images" in test_case["params"]:
-                del test_case["params"]["include_images"]
-            with self.subTest(msg=test_case["name"]):
-                response = asyncio.run(self.tavily_client.qna_search(**test_case["params"]))
-                self.assertIsNotNone(response)
-                self.assertIsInstance(response, str)
-                self.assertTrue(len(response) > 0)
-
-class CompanyInfoSearchTest(unittest.TestCase):
-
-    def setUp(self) -> None:
-        self.tavily_client = AsyncTavilyClient(api_key=os.getenv("TAVILY_API_KEY"))
-        return super().setUp()
-    
-    def tearDown(self) -> None:
-        return super().tearDown()
-    
-    # Every single search result should have these properties
-    def common_search_result_properties(self, result) -> None:
-        self.assertIsInstance(result, dict)
-        self.assertIn("title", result)
-        self.assertIn("url", result)
-        self.assertIn("content", result)
-        self.assertIn("score", result)
-    
-    def test_company_info_search(self) -> None:
-        for test_case in cases:
-            if "topic" in test_case["params"]:
-                del test_case["params"]["topic"]
-            if "include_domains" in test_case["params"]:
-                del test_case["params"]["include_domains"]
-            if "exclude_domains" in test_case["params"]:
-                del test_case["params"]["exclude_domains"]
-            if "include_raw_content" in test_case["params"]:
-                del test_case["params"]["include_raw_content"]
-            if "include_images" in test_case["params"]:
-                del test_case["params"]["include_images"]
-            if "include_answer" in test_case["params"]:
-                del test_case["params"]["include_answer"]
-            if "use_cache" in test_case["params"]:
-                del test_case["params"]["use_cache"]
-            with self.subTest(msg=test_case["name"]):
-                response = asyncio.run(self.tavily_client.get_company_info(**test_case["params"]))
-                self.assertIsNotNone(response)
-                self.assertIsInstance(response, list)
-                self.assertTrue(len(response) > 0)
-                for search_result in response:
-                    self.common_search_result_properties(search_result)
-            
-class ErrorTest(unittest.TestCase):
-    
-    def setUp(self) -> None:
-        return super().setUp()
-    
-    def tearDown(self) -> None:
-        return super().tearDown()
-    
-    # This test is here to ensure that no MissingAPIKeyError is raised when the API key is in the environment
-    def test_load_key_from_env(self) -> None:
-        self.assertIn('results', asyncio.run(AsyncTavilyClient().search("Why is Tavily the best search API?")))
-    
-    def test_missing_api_key(self) -> None:
-        with self.assertRaises(MissingAPIKeyError):
-            AsyncTavilyClient(api_key='')
-        
-        old_key = os.getenv("TAVILY_API_KEY")
-        del os.environ["TAVILY_API_KEY"]
-        with self.assertRaises(MissingAPIKeyError):
-            AsyncTavilyClient()
-            
-        os.environ["TAVILY_API_KEY"] = old_key
-
-
-    def test_invalid_api_key(self) -> None:
-        with self.assertRaises(InvalidAPIKeyError):
-            asyncio.run(AsyncTavilyClient(api_key="invalid_api_key").search("Why is Tavily the best search API?"))
-
-if __name__ == "__main__":
-
-    unittest.main()

tavily_python-0.7.3/tests/test_sync_search.py

@@ -1,219 +0,0 @@
-import unittest
-import os
-from tavily import TavilyClient, InvalidAPIKeyError, MissingAPIKeyError
-from urllib.parse import urlparse
-
-from unit_tests import cases
-
-class SearchTest(unittest.TestCase):
-    
-    def setUp(self) -> None:
-        self.tavily_client = TavilyClient(api_key=os.getenv("TAVILY_API_KEY"))
-        return super().setUp()
-    
-    def tearDown(self) -> None:
-        return super().tearDown()
-    
-    # Every single search result should have these properties
-    def common_search_result_properties(self, result) -> None:
-        self.assertIsInstance(result, dict)
-        self.assertIn("title", result)
-        self.assertIn("url", result)
-        self.assertIn("content", result)
-        self.assertIn("score", result)
-
-    # General search results should have these properties
-    def general_search_result_properties(self, result) -> None:
-        self.common_search_result_properties(result)
-        self.assertIn("raw_content", result)
-
-    # News search results should have these properties
-    def news_search_result_properties(self, result) -> None:
-        self.common_search_result_properties(result)
-        self.assertIn("published_date", result)
-
-    # Topic-specific properties
-    def topic_specific_properties(self, result, **params) -> None:
-        if params.get("topic", "general") == "general":
-            self.assertIn("raw_content", result)
-        elif params.get("topic", "general") == "news":
-            self.assertIn("published_date", result)
-
-    # Domain inclusion/exclusion-dependent properties
-    def domain_dependent_properties(self, response, **params) -> None:
-        if params.get("topic", "general") != "general":
-            return
-
-        if params.get("include_domains", False) and len(params["include_domains"]) > 0:
-            for result in response["results"]:
-                self.assertTrue(any(domain in urlparse(result["url"]).netloc for domain in params["include_domains"]))
-
-        if params.get("exclude_domains", False) and len(params["exclude_domains"]) > 0:
-            for result in response["results"]:
-                self.assertFalse(any(domain in urlparse(result["url"]).netloc for domain in params["exclude_domains"]))
-
-    # Image-dependent properties
-    def image_properties(self, response, **params) -> None:
-        if params.get("topic", "general") == "general" and params.get("include_images", False):
-            self.assertIsNotNone(response["images"])
-            self.assertIsInstance(response["images"], list)
-            for image in response["images"]:
-                self.assertIsInstance(image, str)
-
-    # Answer-dependent properties
-    def answer_properties(self, response, **params) -> None:
-        if params.get("include_answer", False):
-            self.assertIn("answer", response)
-            self.assertIsInstance(response["answer"], str)
-
-
-    # Every single search response should have these properties
-    def common_response_properties(self, response) -> None:
-        self.assertIsNotNone(response)
-        self.assertIsInstance(response, dict)
-        self.assertIn("answer", response)
-        self.assertIn("query", response)
-        self.assertIn("results", response)
-        self.assertIn("images", response)
-        self.assertIn("response_time", response)
-        self.assertIn("follow_up_questions", response)
-
-        self.assertIsNotNone(response["query"])
-        self.assertIsNotNone(response["results"])
-        self.assertIsNotNone(response["response_time"])
-        self.assertIsNotNone(response["images"])
-
-        self.assertIsInstance(response["query"], str)
-        self.assertIsInstance(response["results"], list)
-        self.assertIsInstance(response["response_time"], float)
-        self.assertIsInstance(response["images"], list)
-
-    # Search responses also have properties that depend on the request params
-    def custom_response_properties(self, response, **params) -> None:
-        self.domain_dependent_properties(response, **params)
-        self.image_properties(response, **params)
-        self.answer_properties(response, **params)
-        for result in response["results"]:
-            self.topic_specific_properties(result, **params)
-
-    def test_internal_search(self) -> None:
-        for test_case in cases:
-            with self.subTest(msg=test_case["name"]):
-                result = self.tavily_client._search(**test_case["params"])
-                self.common_response_properties(result)
-                if test_case["params"].get("topic", "general") == "general":
-                    for search_result in result["results"]:
-                        self.general_search_result_properties(search_result)
-                elif test_case["params"].get("topic", "general") == "news":
-                    for search_result in result["results"]:
-                        self.news_search_result_properties(search_result)
-                self.custom_response_properties(result, **test_case["params"])
-
-    def test_external_search(self) -> None:
-        for test_case in cases:
-            with self.subTest(msg=test_case["name"]):
-                response = self.tavily_client._search(**test_case["params"])
-                self.common_response_properties(response)
-                if test_case["params"].get("topic", "general") == "general":
-                    for search_result in response["results"]:
-                        self.general_search_result_properties(search_result)
-                elif test_case["params"].get("topic", "general") == "news":
-                    for search_result in response["results"]:
-                        self.news_search_result_properties(search_result)
-                self.custom_response_properties(response, **test_case["params"])
-
-class QNASearchTest(unittest.TestCase):
-    
-    def setUp(self) -> None:
-        self.tavily_client = TavilyClient(api_key=os.getenv("TAVILY_API_KEY"))
-        return super().setUp()
-    
-    def tearDown(self) -> None:
-        return super().tearDown()
-    
-    def test_qna_search(self) -> None:
-        for test_case in cases:
-            if "include_answer" in test_case["params"]:
-                del test_case["params"]["include_answer"]
-            if "include_raw_content" in test_case["params"]:
-                del test_case["params"]["include_raw_content"]
-            if "include_images" in test_case["params"]:
-                del test_case["params"]["include_images"]
-            with self.subTest(msg=test_case["name"]):
-                response = self.tavily_client.qna_search(**test_case["params"])
-                self.assertIsNotNone(response)
-                self.assertIsInstance(response, str)
-                self.assertTrue(len(response) > 0)
-
-class CompanyInfoSearchTest(unittest.TestCase):
-
-    def setUp(self) -> None:
-        self.tavily_client = TavilyClient(api_key=os.getenv("TAVILY_API_KEY"))
-        return super().setUp()
-    
-    def tearDown(self) -> None:
-        return super().tearDown()
-    
-    # Every single search result should have these properties
-    def common_search_result_properties(self, result) -> None:
-        self.assertIsInstance(result, dict)
-        self.assertIn("title", result)
-        self.assertIn("url", result)
-        self.assertIn("content", result)
-        self.assertIn("score", result)
-    
-    def test_company_info_search(self) -> None:
-        for test_case in cases:
-            if "topic" in test_case["params"]:
-                del test_case["params"]["topic"]
-            if "include_domains" in test_case["params"]:
-                del test_case["params"]["include_domains"]
-            if "exclude_domains" in test_case["params"]:
-                del test_case["params"]["exclude_domains"]
-            if "include_raw_content" in test_case["params"]:
-                del test_case["params"]["include_raw_content"]
-            if "include_images" in test_case["params"]:
-                del test_case["params"]["include_images"]
-            if "include_answer" in test_case["params"]:
-                del test_case["params"]["include_answer"]
-            if "use_cache" in test_case["params"]:
-                del test_case["params"]["use_cache"]
-            with self.subTest(msg=test_case["name"]):
-                response = self.tavily_client.get_company_info(**test_case["params"])
-                self.assertIsNotNone(response)
-                self.assertIsInstance(response, list)
-                self.assertTrue(len(response) > 0)
-                for search_result in response:
-                    self.common_search_result_properties(search_result)
-            
-class ErrorTest(unittest.TestCase):
-    
-    def setUp(self) -> None:
-        return super().setUp()
-    
-    def tearDown(self) -> None:
-        return super().tearDown()
-    
-    # This test is here to ensure that no MissingAPIKeyError is raised when the API key is in the environment
-    def test_load_key_from_env(self) -> None:
-        self.assertIn('results', TavilyClient().search("Why is Tavily the best search API?"))
-    
-    def test_missing_api_key(self) -> None:
-        with self.assertRaises(MissingAPIKeyError):
-            TavilyClient(api_key='')
-        
-        old_key = os.getenv("TAVILY_API_KEY")
-        del os.environ["TAVILY_API_KEY"]
-        with self.assertRaises(MissingAPIKeyError):
-            TavilyClient()
-            
-        os.environ["TAVILY_API_KEY"] = old_key
-
-
-    def test_invalid_api_key(self) -> None:
-        with self.assertRaises(InvalidAPIKeyError):
-            TavilyClient(api_key="invalid_api_key").search("Why is Tavily the best search API?")
-
-if __name__ == "__main__":
-
-    unittest.main()