Create README.md

README.md

@@ -0,0 +1,134 @@
+See: https://github.com/Halluminate/browserbench
+
+# BrowserBench
+
+BrowserBench exercises multiple hosted Chromium providers against a shared set of autonomous web-browsing tasks. It wraps the provider-specific session bootstrap in `browser_test.py` and coordinates parallel task execution in `run_browserbench.py`, emitting timestamped CSV reports so you can compare reliability and latency provider by provider.
+
+## Repository Layout
+- `run_browserbench.py` – asynchronous benchmark runner; loads tasks from CSV, fans them out with bounded concurrency, and writes aggregated results.
+- `browser_test.py` – single-task harness that spins up a provider session, runs the `browser_use` agent, captures the final message, and performs provider-specific teardown.
+- `providers/` – lightweight adapters for Anchor, Browserbase, SteelBrowser, and Hyperbrowser. Each exposes `create_session(...)` and `cleanup_session(...)` so the runner never touches SDK details.
+- `browserbench.csv` / `test_tasks.csv` – canonical and sandbox task lists. Each row describes the start URL, natural-language instruction, and ground-truth expectation.
+- `results/` – auto-created folder containing `browserbench_results_<provider>_<timestamp>.csv` exports for every run.
+- `pyproject.toml` – Project configuration and dependencies for uv package management.
+- `requirements.txt` – Python dependencies (maintained for pip compatibility).
+
+## Prerequisites
+
+### Installation with uv (Recommended)
+[uv](https://github.com/astral-sh/uv) is a fast Python package installer and resolver. If you don't have it installed:
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Then install dependencies:
+```bash
+# Install all dependencies
+uv sync
+
+# Run commands with uv
+uv run python run_browserbench.py --help
+uv run python browser_test.py --help
+```
+
+### Installation with pip (Alternative)
+If you prefer traditional pip:
+```bash
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install dependencies
+pip install -r requirements.txt
+```
+
+### Environment Variables
+Create a `.env` file in the project root with the following variables:
+```bash
+# OpenAI API Key (required for all providers)
+OPENAI_API_KEY=your_openai_api_key_here
+
+# Anchor Browser API Key
+ANCHOR_API_KEY=your_anchor_api_key_here
+
+# Browserbase API credentials
+BROWSERBASE_API_KEY=your_browserbase_api_key_here
+BROWSERBASE_PROJECT_ID=your_browserbase_project_id_here
+
+# Steel Browser API Key
+STEEL_API_KEY=your_steel_api_key_here
+
+# Hyperbrowser API Key
+HYPERBROWSER_API_KEY=your_hyperbrowser_api_key_here
+```
+
+Alternatively, export them manually in your shell. Both `run_browserbench.py` and `browser_test.py` call `python-dotenv.load_dotenv()`, so a local `.env` file is respected automatically.
+
+## Running the Benchmark Suite
+
+### With uv:
+```bash
+uv run python run_browserbench.py \
+  --provider browserbase \
+  --concurrency 5 \
+  --tasks 20 \
+  --csv-file browserbench.csv
+```
+
+### With pip/virtualenv:
+```bash
+python run_browserbench.py \
+  --provider browserbase \
+  --concurrency 5 \
+  --tasks 20 \
+  --csv-file browserbench.csv
+```
+
+Key flags:
+- `--provider {anchor|browserbase|steelbrowser|hyperbrowser}` – choose which adapter to exercise. Each run targets a single provider.
+- `--concurrency <int>` – number of simultaneous browser sessions. The runner uses an `asyncio.Semaphore` to cap parallelism.
+- `--tasks <int>` – optionally limit the number of rows pulled from the CSV.
+- `--csv-file <path>` – alternate task list.
+- `--output <filename>` – custom name for the result CSV (otherwise auto-generated).
+- `--no-stealth` – disable provider-specific stealth settings where available.
+
+The runner validates that required environment variables exist, loads tasks, dispatches them through `browser_test.main(...)`, and writes a CSV report under `results/`. Each row includes:
+- task metadata (ID, prompt, URLs, ground truth)
+- provider + configuration fields (`provider`, `timestamp`, `success`, `error_message`)
+- completion info (`agent_result`, `session_url`, `execution_time`)
+
+## Running a Single Task
+Use `browser_test.py` when you need to debug prompts or provider wiring:
+
+### With uv:
+```bash
+uv run python browser_test.py --provider steelbrowser --task "Find the latest pricing for the Oculus Quest 3" --no-stealth
+```
+
+### With pip/virtualenv:
+```bash
+python browser_test.py --provider steelbrowser --task "Find the latest pricing for the Oculus Quest 3" --no-stealth
+```
+This script spins up the requested provider, launches the `browser_use.Agent`, streams intermediate logging, and returns both the final natural-language answer and any provider session URL/recording. Cleanup is performed automatically even on failure.
+
+## Provider Behaviors
+All adapters follow the same two-function contract but expose slightly different features:
+- **Anchor** – provisions a mobile proxy with CAPTCHA solving and returns a CDP URL alongside recording links.
+- **Browserbase** – can enable `advanced_stealth` + proxies; session URLs follow `https://www.browserbase.com/sessions/<id>`.
+- **SteelBrowser** – REST API for session creation/release with optional stealth payload (`useProxy`, `solveCaptcha`, `stealthConfig`).
+- **Hyperbrowser** – REST API for session start/stop, optional stealth/captcha solving, and direct session playback URLs.
+
+Because the runner calls `browser_test.main(...)`, any provider enhancements made there automatically propagate to batch runs.
+
+## Customising Task Sets
+The benchmark CSV expects four columns: `starting_url`, `Task`, `ground_truth_url`, and `Ground Truth`. Add rows, duplicate the file under a new name, and supply it via `--csv-file`. For quick smoke tests, trim the dataset or point to `test_tasks.csv` with a small subset of records.
+
+## Operational Notes
+- Logging is configured at `INFO` level in `run_browserbench.py`; per-task start/stop messages stream to stdout.
+- Result files are overwritten only when you supply the same `--output` name. The default timestamped filenames are unique.
+- Failures are captured with the raised exception stored in `error_message`; the row still appears in the CSV so aggregate success rates remain accurate.
+- Session teardown happens in adapter-specific `cleanup_session(...)` calls. We still attempt to return human-usable session URLs even if the cleanup API raises.
+
+## Next Steps
+- Integrate the produced CSVs with your analytics tooling to visualise latency and success deltas per provider.
+- Extend `providers/` with additional adapters by mirroring the `create_session`/`cleanup_session` contract and adding the provider name to the CLI choices in both scripts.