Skip to content

Commit a246af2

Browse files
authored
Update README.md for clarity on environment setup and integration tests (#56)
1 parent add6257 commit a246af2

1 file changed

Lines changed: 3 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,11 @@ A minimal Reason-and-Act (ReAct) agent for knowledge retrieval, implemented with
3838
- **[1.1 ReAct Agent for RAG](src/1_basics/1_react_rag/README.md)**
3939
Basic ReAct agent for step-by-step retrieval and answer generation.
4040

41-
4241
## Getting Started
4342

44-
Set your API keys in `.env`. Use `.env.example` as a template.
45-
46-
```bash
47-
cp -v .env.example .env
48-
```
43+
If you successfully created a workspace in Coder, you should already have a `.env` file in the repo.
4944

50-
Run integration tests to validate that your API keys are set up correctly.
45+
In that case you can verify that the API keys work by running integration tests with the following command:
5146

5247
```bash
5348
uv run --env-file .env pytest -sv tests/tool_tests/test_integration.py
@@ -91,7 +86,6 @@ As noted above, these are unnecessarily verbose for real applications.
9186
# uv run --env-file .env gradio src/1_basics/1_react_rag/app.py
9287
```
9388

94-
9589
### 2. Frameworks
9690

9791
Reason-and-Act Agent without the boilerplate- using the OpenAI Agent SDK.
@@ -105,15 +99,14 @@ Multi-agent examples, also via the OpenAI Agent SDK.
10599

106100
```bash
107101
uv run --env-file .env gradio src/2_frameworks/2_multi_agent/efficient.py
108-
# Verbose option- greater control over the agent flow, but less flexible.
102+
# Verbose option - greater control over the agent flow, but less flexible.
109103
# uv run --env-file .env gradio src/2_frameworks/2_multi_agent/verbose.py
110104
```
111105

112106
Python Code Interpreter demo- using the OpenAI Agent SDK, E2B for secure code sandbox, and LangFuse for observability. Refer to [src/2_frameworks/3_code_interpreter/README.md](src/2_frameworks/3_code_interpreter/README.md) for details.
113107

114108
MCP server integration example also via OpenAI Agents SDK with Gradio and Langfuse tracing. Refer to [src/2_frameworks/4_mcp/README.md](src/2_frameworks/4_mcp/README.md) for more details.
115109

116-
117110
### 3. Evals
118111

119112
Synthetic data.

0 commit comments

Comments
 (0)