Skip to content

Update README.md for clarity on .env file #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fcogidi merged 1 commit into from
Jan 21, 2026
Merged

Update README.md for clarity on .env file #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,11 @@ A minimal Reason-and-Act (ReAct) agent for knowledge retrieval, implemented with
- **[1.1 ReAct Agent for RAG](src/1_basics/1_react_rag/README.md)**
Basic ReAct agent for step-by-step retrieval and answer generation.


## Getting Started

Set your API keys in `.env`. Use `.env.example` as a template.

```bash
cp -v .env.example .env
```
If you successfully created a workspace in Coder, you should already have a `.env` file in the repo.

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

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


### 2. Frameworks

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

```bash
uv run --env-file .env gradio src/2_frameworks/2_multi_agent/efficient.py
# Verbose option- greater control over the agent flow, but less flexible.
# Verbose option - greater control over the agent flow, but less flexible.
# uv run --env-file .env gradio src/2_frameworks/2_multi_agent/verbose.py
```

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.

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.


### 3. Evals

Synthetic data.
Expand Down