Merge pull request #6 from browserbase/anirudh/add-basic-examples

add rye + basic examples

Author: kamath

.gitignore

@@ -14,3 +14,5 @@ dist
 .envrc
 codegen.log
 Brewfile.lock.json
+screenshot.png
+openapi.v1.yaml

README.md

@@ -50,17 +50,18 @@ so that your API Key is not stored in source control.
 
 See the [examples](examples) directory for more usage examples.
 
+> [!NOTE]
+> Running the examples requires [Rye](https://rye.astral.sh/) to be installed.
+
 To run the examples, clone this repository and run the following commands from the project root (this directory):
 
 ```bash
-python3 -m venv .venv
-source .venv/bin/activate
-python3 -m pip install .
-python3 -m examples/02_create_session.py # replace with the example you want to run
+rye sync
+rye run example playwright_basic # replace with the example you want to run
 ```
 
-!!! note
-    Make sure you have a `.env` file that matches the [.env.example](.env.example) file in the root of this repository.
+> [!NOTE]
+> Make sure you have a `.env` file that matches the [.env.example](.env.example) file in the root of this repository.
 
 ## Async usage
 

examples/01_quickstart.py

@@ -0,0 +1,24 @@
+import os
+
+from dotenv import load_dotenv
+
+from browserbase import Browserbase
+
+# Load our environment variables
+load_dotenv(override=True)
+
+# Make sure we have the required environment variables
+BROWSERBASE_CONNECT_URL = os.environ.get(
+    "BROWSERBASE_CONNECT_URL", "wss://connect.browserbase.com"
+)
+_BROWSERBASE_API_KEY = os.environ.get("BROWSERBASE_API_KEY")
+if not _BROWSERBASE_API_KEY:
+    raise ValueError("BROWSERBASE_API_KEY is not set in environment")
+BROWSERBASE_API_KEY: str = _BROWSERBASE_API_KEY
+_BROWSERBASE_PROJECT_ID = os.environ.get("BROWSERBASE_PROJECT_ID")
+if not _BROWSERBASE_PROJECT_ID:
+    raise ValueError("BROWSERBASE_PROJECT_ID is not set in environment")
+BROWSERBASE_PROJECT_ID = _BROWSERBASE_PROJECT_ID or ""
+
+# Instantiate our Browserbase client
+bb = Browserbase(api_key=BROWSERBASE_API_KEY)

examples/02_create_session.py

@@ -0,0 +1,26 @@
+# End-to-end tests
+
+This directory contains end-to-end tests that run against a real Browserbase instance.
+
+## Running the tests
+
+To run the tests, you will need to set the following environment variables:
+
+- `BROWSERBASE_API_KEY`: Your Browserbase API key
+- `BROWSERBASE_PROJECT_ID`: The ID of the project you want to use for the tests
+
+You can set these variables in a `.env` file in the root of this directory.
+
+Then, run the tests with:
+
+```sh
+$ rye run test:e2e
+```
+
+## Writing tests
+
+The tests are written using pytest and the [pytest-playwright](https://playwright.dev/python/docs/pytest) plugin.
+
+You can find more information about writing tests in the [pytest documentation](https://docs.pytest.org/en/7.1.x/).
+
+To submit a test, create a new file in the `e2e` directory with a name that describes the test and starts with `test_`.

examples/__init__.py

@@ -0,0 +1 @@
+

examples/e2e/README.md

@@ -0,0 +1,21 @@
+import pytest
+from playwright.sync_api import Playwright, sync_playwright
+
+from browserbase import Browserbase
+
+from .. import (
+    BROWSERBASE_API_KEY,
+    playwright_basic,
+)
+
+bb = Browserbase(api_key=BROWSERBASE_API_KEY)
+
+
+@pytest.fixture(scope="session")
+def playwright():
+    with sync_playwright() as p:
+        yield p
+
+
+def test_playwright_basic(playwright: Playwright):
+    playwright_basic.run(playwright)

examples/e2e/__init__.py

@@ -0,0 +1,41 @@
+from playwright.sync_api import Playwright, sync_playwright
+
+from examples import (
+    BROWSERBASE_API_KEY,
+    BROWSERBASE_PROJECT_ID,
+    BROWSERBASE_CONNECT_URL,
+    bb,
+)
+
+
+def run(playwright: Playwright):
+    # Create a session on Browserbase
+    session = bb.sessions.create(project_id=BROWSERBASE_PROJECT_ID)
+    assert session.id is not None
+    assert session.status == "RUNNING", f"Session status is {session.status}"
+
+    # Connect to the remote session
+    connect_url = (
+        f"{BROWSERBASE_CONNECT_URL}?sessionId={session.id}&apiKey={BROWSERBASE_API_KEY}"
+    )
+    chromium = playwright.chromium
+    browser = chromium.connect_over_cdp(connect_url)
+    context = browser.contexts[0]
+    page = context.pages[0]
+
+    # Execute Playwright actions on the remote browser tab
+    page.goto("https://news.ycombinator.com/")
+    page_title = page.title()
+    assert (
+        page_title == "Hacker News"
+    ), f"Page title is not 'Hacker News', it is '{page_title}'"
+    page.screenshot(path="screenshot.png")
+
+    page.close()
+    browser.close()
+    print("Done!")
+
+
+if __name__ == "__main__":
+    with sync_playwright() as playwright:
+        run(playwright)

examples/e2e/test_playwright_basic.py

@@ -50,12 +50,15 @@ dev-dependencies = [
     "respx",
     "pytest",
     "pytest-asyncio",
+    "pytest-playwright",
     "ruff",
     "time-machine",
     "nox",
     "dirty-equals>=0.6.0",
     "importlib-metadata>=6.7.0",
     "rich>=13.7.1",
+    "python-dotenv",
+    "playwright",
 ]
 
 [tool.rye.scripts]
@@ -79,10 +82,15 @@ format = { chain = [
 
 "check:importable" = "python -c 'import browserbase'"
 
+"example" = "python -c 'import sys; from pathlib import Path; example = Path(\"examples\") / (sys.argv[1] + \".py\"); exec(open(example).read())'"
+
+"test:e2e" = "python -m pytest examples/e2e"
+
 typecheck = { chain = [
   "typecheck:pyright",
   "typecheck:mypy"
 ]}
+
 "typecheck:pyright" = "pyright"
 "typecheck:verify-types" = "pyright --verifytypes browserbase --ignoreexternal"
 "typecheck:mypy" = "mypy ."