Merge pull request #137 from siddas27/feature/BraveSearchTool

add brave search tool

src/crewai_tools/__init__.py

@@ -1,4 +1,5 @@
 from .tools import (
+    BraveSearchTool,
     BrowserbaseLoadTool,
     CodeDocsSearchTool,
     CodeInterpreterTool,
@@ -19,6 +20,7 @@ from .tools import (
     LlamaIndexTool,
     MDXSearchTool,
     MultiOnTool,
+    MySQLSearchTool,
     NL2SQLTool,
     PDFSearchTool,
     PGSearchTool,
@@ -40,6 +42,5 @@ from .tools import (
     XMLSearchTool,
     YoutubeChannelSearchTool,
     YoutubeVideoSearchTool,
-    MySQLSearchTool
 )
 from .tools.base_tool import BaseTool, Tool, tool

src/crewai_tools/tools/__init__.py

@@ -1,3 +1,4 @@
+from .brave_search_tool.brave_search_tool import BraveSearchTool
 from .browserbase_load_tool.browserbase_load_tool import BrowserbaseLoadTool
 from .code_docs_search_tool.code_docs_search_tool import CodeDocsSearchTool
 from .code_interpreter_tool.code_interpreter_tool import CodeInterpreterTool
@@ -11,10 +12,10 @@ from .exa_tools.exa_search_tool import EXASearchTool
 from .file_read_tool.file_read_tool import FileReadTool
 from .file_writer_tool.file_writer_tool import FileWriterTool
 from .firecrawl_crawl_website_tool.firecrawl_crawl_website_tool import (
-    FirecrawlCrawlWebsiteTool
+    FirecrawlCrawlWebsiteTool,
 )
 from .firecrawl_scrape_website_tool.firecrawl_scrape_website_tool import (
-    FirecrawlScrapeWebsiteTool
+    FirecrawlScrapeWebsiteTool,
 )
 from .firecrawl_search_tool.firecrawl_search_tool import FirecrawlSearchTool
 from .github_search_tool.github_search_tool import GithubSearchTool
@@ -22,16 +23,17 @@ from .json_search_tool.json_search_tool import JSONSearchTool
 from .llamaindex_tool.llamaindex_tool import LlamaIndexTool
 from .mdx_seach_tool.mdx_search_tool import MDXSearchTool
 from .multion_tool.multion_tool import MultiOnTool
+from .mysql_search_tool.mysql_search_tool import MySQLSearchTool
 from .nl2sql.nl2sql_tool import NL2SQLTool
 from .pdf_search_tool.pdf_search_tool import PDFSearchTool
 from .pg_seach_tool.pg_search_tool import PGSearchTool
 from .rag.rag_tool import RagTool
 from .scrape_element_from_website.scrape_element_from_website import (
-    ScrapeElementFromWebsiteTool
+    ScrapeElementFromWebsiteTool,
 )
 from .scrape_website_tool.scrape_website_tool import ScrapeWebsiteTool
 from .scrapfly_scrape_website_tool.scrapfly_scrape_website_tool import (
-    ScrapflyScrapeWebsiteTool
+    ScrapflyScrapeWebsiteTool,
 )
 from .selenium_scraping_tool.selenium_scraping_tool import SeleniumScrapingTool
 from .serper_dev_tool.serper_dev_tool import SerperDevTool
@@ -46,7 +48,6 @@ from .vision_tool.vision_tool import VisionTool
 from .website_search.website_search_tool import WebsiteSearchTool
 from .xml_search_tool.xml_search_tool import XMLSearchTool
 from .youtube_channel_search_tool.youtube_channel_search_tool import (
-    YoutubeChannelSearchTool
+    YoutubeChannelSearchTool,
 )
 from .youtube_video_search_tool.youtube_video_search_tool import YoutubeVideoSearchTool
-from .mysql_search_tool.mysql_search_tool import MySQLSearchTool

src/crewai_tools/tools/brave_search_tool/README.md

@@ -0,0 +1,30 @@
+# BraveSearchTool Documentation
+
+## Description
+This tool is designed to perform a web search for a specified query from a text's content across the internet. It utilizes the Brave Web Search API, which is a REST API to query Brave Search and get back search results from the web. The following sections describe how to curate requests, including parameters and headers, to Brave Web Search API and get a JSON response back.
+
+## Installation
+To incorporate this tool into your project, follow the installation instructions below:
+```shell
+pip install 'crewai[tools]'
+```
+
+## Example
+The following example demonstrates how to initialize the tool and execute a search with a given query:
+
+```python
+from crewai_tools import BraveSearchTool
+
+# Initialize the tool for internet searching capabilities
+tool = BraveSearchTool()
+```
+
+## Steps to Get Started
+To effectively use the `BraveSearchTool`, follow these steps:
+
+1. **Package Installation**: Confirm that the `crewai[tools]` package is installed in your Python environment.
+2. **API Key Acquisition**: Acquire a API key [here](https://api.search.brave.com/app/keys).
+3. **Environment Configuration**: Store your obtained API key in an environment variable named `BRAVE_API_KEY` to facilitate its use by the tool.
+
+## Conclusion
+By integrating the `BraveSearchTool` into Python projects, users gain the ability to conduct real-time, relevant searches across the internet directly from their applications. By adhering to the setup and usage guidelines provided, incorporating this tool into projects is streamlined and straightforward.

src/crewai_tools/tools/brave_search_tool/brave_search_tool.py

@@ -0,0 +1,119 @@
+import datetime
+import os
+import time
+from typing import Any, ClassVar, Optional, Type
+
+import requests
+from pydantic import BaseModel, Field
+
+from crewai_tools.tools.base_tool import BaseTool
+
+
+def _save_results_to_file(content: str) -> None:
+    """Saves the search results to a file."""
+    filename = f"search_results_{datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}.txt"
+    with open(filename, "w") as file:
+        file.write(content)
+    print(f"Results saved to {filename}")
+
+
+class BraveSearchToolSchema(BaseModel):
+    """Input for BraveSearchTool."""
+
+    search_query: str = Field(
+        ..., description="Mandatory search query you want to use to search the internet"
+    )
+
+
+class BraveSearchTool(BaseTool):
+    """
+    BraveSearchTool - A tool for performing web searches using the Brave Search API.
+
+    This module provides functionality to search the internet using Brave's Search API,
+    supporting customizable result counts and country-specific searches.
+
+    Dependencies:
+        - requests
+        - pydantic
+        - python-dotenv (for API key management)
+    """
+
+    name: str = "Brave Web Search the internet"
+    description: str = (
+        "A tool that can be used to search the internet with a search_query."
+    )
+    args_schema: Type[BaseModel] = BraveSearchToolSchema
+    search_url: str = "https://api.search.brave.com/res/v1/web/search"
+    country: Optional[str] = ""
+    n_results: int = 10
+    save_file: bool = False
+    _last_request_time: ClassVar[float] = 0
+    _min_request_interval: ClassVar[float] = 1.0  # seconds
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if "BRAVE_API_KEY" not in os.environ:
+            raise ValueError(
+                "BRAVE_API_KEY environment variable is required for BraveSearchTool"
+            )
+
+    def _run(
+        self,
+        **kwargs: Any,
+    ) -> Any:
+        current_time = time.time()
+        if (current_time - self._last_request_time) < self._min_request_interval:
+            time.sleep(
+                self._min_request_interval - (current_time - self._last_request_time)
+            )
+        BraveSearchTool._last_request_time = time.time()
+        try:
+            search_query = kwargs.get("search_query") or kwargs.get("query")
+            if not search_query:
+                raise ValueError("Search query is required")
+
+            save_file = kwargs.get("save_file", self.save_file)
+            n_results = kwargs.get("n_results", self.n_results)
+
+            payload = {"q": search_query, "count": n_results}
+
+            if self.country != "":
+                payload["country"] = self.country
+
+            headers = {
+                "X-Subscription-Token": os.environ["BRAVE_API_KEY"],
+                "Accept": "application/json",
+            }
+
+            response = requests.get(self.search_url, headers=headers, params=payload)
+            response.raise_for_status()  # Handle non-200 responses
+            results = response.json()
+
+            if "web" in results:
+                results = results["web"]["results"]
+                string = []
+                for result in results:
+                    try:
+                        string.append(
+                            "\n".join(
+                                [
+                                    f"Title: {result['title']}",
+                                    f"Link: {result['url']}",
+                                    f"Snippet: {result['description']}",
+                                    "---",
+                                ]
+                            )
+                        )
+                    except KeyError:
+                        continue
+
+            content = "\n".join(string)
+        except requests.RequestException as e:
+            return f"Error performing search: {str(e)}"
+        except KeyError as e:
+            return f"Error parsing search results: {str(e)}"
+        if save_file:
+            _save_results_to_file(content)
+            return f"\nSearch results: {content}\n"
+        else:
+            return content

tests/tools/brave_search_tool_test.py

@@ -0,0 +1,50 @@
+from unittest.mock import patch
+
+import pytest
+
+from crewai_tools.tools.brave_search_tool.brave_search_tool import BraveSearchTool
+
+
+@pytest.fixture
+def brave_tool():
+    return BraveSearchTool(n_results=2)
+
+
+def test_brave_tool_initialization():
+    tool = BraveSearchTool()
+    assert tool.n_results == 10
+    assert tool.save_file is False
+
+
+@patch("requests.get")
+def test_brave_tool_search(mock_get, brave_tool):
+    mock_response = {
+        "web": {
+            "results": [
+                {
+                    "title": "Test Title",
+                    "url": "http://test.com",
+                    "description": "Test Description",
+                }
+            ]
+        }
+    }
+    mock_get.return_value.json.return_value = mock_response
+
+    result = brave_tool.run(search_query="test")
+    assert "Test Title" in result
+    assert "http://test.com" in result
+
+
+def test_brave_tool():
+    tool = BraveSearchTool(
+        n_results=2,
+    )
+    x = tool.run(search_query="ChatGPT")
+    print(x)
+
+
+if __name__ == "__main__":
+    test_brave_tool()
+    test_brave_tool_initialization()
+    # test_brave_tool_search(brave_tool)