Added local example

Author: monadoid

examples/local_example.py

@@ -0,0 +1,79 @@
+"""
+Example demonstrating how to run Stagehand in local mode using the SEA binary
+that ships with the PyPI wheel.
+
+Required environment variables:
+- BROWSERBASE_API_KEY (can be any value in local mode)
+- BROWSERBASE_PROJECT_ID (can be any value in local mode)
+- MODEL_API_KEY (used for client configuration even in local mode)
+- OPENAI_API_KEY (used by the SEA server for LLM access)
+
+Install the published wheel before running this script:
+  `pip install stagehand-alpha`
+Then execute this example with the same interpreter:
+  `python examples/local_example.py`
+"""
+
+import os
+import sys
+
+from stagehand import Stagehand
+
+
+def main() -> None:
+    openai_key = os.environ.get("OPENAI_API_KEY")
+    if not openai_key:
+        sys.exit("Set the OPENAI_API_KEY environment variable to run the local server.")
+
+    client = Stagehand(
+        server="local",
+        local_openai_api_key=openai_key,
+        local_ready_timeout_s=30.0,
+    )
+
+    session_id: str | None = None
+
+    try:
+        print("⏳ Starting local session (this will start the embedded SEA binary)...")
+        session = client.sessions.start(
+            model_name="openai/gpt-5-nano",
+            browser={
+                "type": "local",
+                "launchOptions": {
+                    "headless": True,
+                },
+            },
+        )
+        session_id = session.data.session_id
+        print(f"✅ Session started: {session_id}")
+
+        print("🌐 Navigating to https://www.example.com...")
+        client.sessions.navigate(
+            id=session_id,
+            url="https://www.example.com",
+            frame_id="",
+        )
+        print("✅ Navigation complete")
+
+        print("🔍 Extracting the main heading text...")
+        extract_response = client.sessions.extract(
+            id=session_id,
+            instruction="Extract the text of the top-level heading on this page.",
+        )
+        print(f"📄 Extracted data: {extract_response.data.result}")
+
+    except Exception as exc:
+        print(f"❌ Encountered an error: {exc}")
+        raise
+    finally:
+        if session_id:
+            print("🛑 Ending session...")
+            client.sessions.end(id=session_id)
+            print("✅ Session ended")
+        print("🔌 Closing client (shuts down the SEA server)...")
+        client.close()
+        print("✅ Local server shut down")
+
+
+if __name__ == "__main__":
+    main()