Skip to content

Commit 89164ee

Browse files
update examples and README
1 parent 9e82aba commit 89164ee

File tree

5 files changed

+355
-345
lines changed

5 files changed

+355
-345
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
MODEL_API_KEY = "anthropic-or-openai-api-key"
1+
MODEL_API_KEY = "your-favorite-llm-api-key"
22
BROWSERBASE_API_KEY = "browserbase-api-key"
33
BROWSERBASE_PROJECT_ID = "browserbase-project-id"
44
STAGEHAND_API_URL = "api_url"

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,11 @@ git clone https://github.com/browserbase/stagehand-python.git
9393
cd stagehand-python
9494

9595
# Install in editable mode with development dependencies
96-
pip install -e .[dev]
96+
pip install -e ".[dev]"
97+
98+
### INSTRUCTION TO BE REMOVED BEFORE RELEASE
99+
# install google cua
100+
pip install temp/path-to-the-cua-wheel.wheel
97101
```
98102

99103
## Requirements
@@ -111,21 +115,21 @@ The main dependencies include:
111115

112116
### Development Dependencies
113117

114-
The development dependencies are automatically installed when using `pip install -e .[dev]` and include:
118+
The development dependencies are automatically installed when using `pip install -e ".[dev]"` and include:
115119
- pytest, pytest-asyncio, pytest-mock, pytest-cov (testing)
116120
- black, isort, ruff (code formatting and linting)
117121
- mypy (type checking)
118122
- rich (enhanced terminal output)
119123

120124
## Environment Variables
121125

122-
Before running your script, set the following environment variables:
126+
Before running your script, copy `.env.example` to `.env.` set the following environment variables:
123127

124128
```bash
125-
export BROWSERBASE_API_KEY="your-api-key"
126-
export BROWSERBASE_PROJECT_ID="your-project-id"
129+
export BROWSERBASE_API_KEY="your-api-key" # if running remotely
130+
export BROWSERBASE_PROJECT_ID="your-project-id" # if running remotely
127131
export MODEL_API_KEY="your-openai-api-key" # or your preferred model's API key
128-
export STAGEHAND_API_URL="url-of-stagehand-server"
132+
export STAGEHAND_API_URL="url-of-stagehand-server" # if running remotely
129133
export STAGEHAND_ENV="BROWSERBASE" # or "LOCAL" to run Stagehand locally
130134
```
131135

0 commit comments

Comments
 (0)