Squashed 'packages/tools/' content from commit 78317b9c

git-subtree-dir: packages/tools
git-subtree-split: 78317b9c127f18bd040c1d77e3c0840cdc9a5b38

crewai_tools/tools/browserbase_load_tool/README.md

@@ -0,0 +1,38 @@
+# BrowserbaseLoadTool
+
+## Description
+
+[Browserbase](https://browserbase.com) is a developer platform to reliably run, manage, and monitor headless browsers.
+
+ Power your AI data retrievals with:
+ - [Serverless Infrastructure](https://docs.browserbase.com/under-the-hood) providing reliable browsers to extract data from complex UIs
+ - [Stealth Mode](https://docs.browserbase.com/features/stealth-mode) with included fingerprinting tactics and automatic captcha solving
+ - [Session Debugger](https://docs.browserbase.com/features/sessions) to inspect your Browser Session with networks timeline and logs
+ - [Live Debug](https://docs.browserbase.com/guides/session-debug-connection/browser-remote-control) to quickly debug your automation
+
+## Installation
+
+- Get an API key and Project ID from [browserbase.com](https://browserbase.com) and set it in environment variables (`BROWSERBASE_API_KEY`, `BROWSERBASE_PROJECT_ID`).
+- Install the [Browserbase SDK](http://github.com/browserbase/python-sdk) along with `crewai[tools]` package:
+
+```
+pip install browserbase 'crewai[tools]'
+```
+
+## Example
+
+Utilize the BrowserbaseLoadTool as follows to allow your agent to load websites:
+
+```python
+from crewai_tools import BrowserbaseLoadTool
+
+tool = BrowserbaseLoadTool()
+```
+
+## Arguments
+
+- `api_key` Optional. Browserbase API key. Default is `BROWSERBASE_API_KEY` env variable.
+- `project_id` Optional. Browserbase Project ID. Default is `BROWSERBASE_PROJECT_ID` env variable.
+- `text_content` Retrieve only text content. Default is `False`.
+- `session_id` Optional. Provide an existing Session ID.
+- `proxy` Optional. Enable/Disable Proxies."

crewai_tools/tools/browserbase_load_tool/browserbase_load_tool.py

@@ -0,0 +1,67 @@
+import os
+from typing import Any, Optional, Type, List
+
+from crewai.tools import BaseTool, EnvVar
+from pydantic import BaseModel, Field
+
+
+class BrowserbaseLoadToolSchema(BaseModel):
+    url: str = Field(description="Website URL")
+
+
+class BrowserbaseLoadTool(BaseTool):
+    name: str = "Browserbase web load tool"
+    description: str = "Load webpages url in a headless browser using Browserbase and return the contents"
+    args_schema: Type[BaseModel] = BrowserbaseLoadToolSchema
+    api_key: Optional[str] = os.getenv("BROWSERBASE_API_KEY")
+    project_id: Optional[str] = os.getenv("BROWSERBASE_PROJECT_ID")
+    text_content: Optional[bool] = False
+    session_id: Optional[str] = None
+    proxy: Optional[bool] = None
+    browserbase: Optional[Any] = None
+    package_dependencies: List[str] = ["browserbase"]
+    env_vars: List[EnvVar] = [
+        EnvVar(name="BROWSERBASE_API_KEY", description="API key for Browserbase services", required=False),
+        EnvVar(name="BROWSERBASE_PROJECT_ID", description="Project ID for Browserbase services", required=False),
+    ]
+
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        project_id: Optional[str] = None,
+        text_content: Optional[bool] = False,
+        session_id: Optional[str] = None,
+        proxy: Optional[bool] = None,
+        **kwargs,
+    ):
+        super().__init__(**kwargs)
+        if not self.api_key:
+            raise EnvironmentError(
+                "BROWSERBASE_API_KEY environment variable is required for initialization"
+            )
+        try:
+            from browserbase import Browserbase  # type: ignore
+        except ImportError:
+            import click
+
+            if click.confirm(
+                "`browserbase` package not found, would you like to install it?"
+            ):
+                import subprocess
+
+                subprocess.run(["uv", "add", "browserbase"], check=True)
+                from browserbase import Browserbase  # type: ignore
+            else:
+                raise ImportError(
+                    "`browserbase` package not found, please run `uv add browserbase`"
+                )
+
+        self.browserbase = Browserbase(api_key=self.api_key)
+        self.text_content = text_content
+        self.session_id = session_id
+        self.proxy = proxy
+
+    def _run(self, url: str):
+        return self.browserbase.load_url(
+            url, self.text_content, self.session_id, self.proxy
+        )