Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 6 additions & 7 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@

## Prerequisites

1. **Rust toolchain** (1.75+) and **maturin** (`pip install maturin`)
1. Python 3.8+
2. A Python virtual environment (the project already has one at `.venv/`)

## Setup

Build and install the `effect-log` Python package in dev mode:
Install the `ai-effectlog` package from PyPI:

```bash
cd bindings/python
maturin develop
pip install ai-effectlog
```

If you're using the project's existing venv, activate it first:
Expand Down Expand Up @@ -47,15 +46,15 @@ They require the corresponding SDK packages **and** an `OPENAI_API_KEY`.
export OPENAI_API_KEY="sk-..."

# OpenAI Agents SDK
pip install openai-agents
pip install ai-effectlog openai-agents
python examples/e2e_openai_agents.py

# CrewAI
pip install crewai crewai-tools
pip install ai-effectlog crewai crewai-tools
python examples/e2e_crewai.py

# LangGraph
pip install langchain-core langchain-openai langgraph
pip install ai-effectlog langchain-core langchain-openai langgraph
python examples/e2e_langgraph.py
```

Expand Down
2 changes: 1 addition & 1 deletion examples/crewai_integration.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This example runs standalone. With crewai installed,
you can also use the middleware wrappers shown in comments.

pip install effect-log crewai
pip install ai-effectlog crewai
"""

import os
Expand Down
3 changes: 1 addition & 2 deletions examples/e2e_crewai.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
End-to-end CrewAI + effect-log example.

Setup:
cd bindings/python && maturin develop # install effect-log from source
pip install crewai crewai-tools # install the CrewAI SDK
pip install ai-effectlog crewai crewai-tools

Set your API key (CrewAI uses OpenAI by default):
export OPENAI_API_KEY="sk-..."
Expand Down
3 changes: 1 addition & 2 deletions examples/e2e_langgraph.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
End-to-end LangGraph + effect-log example.

Setup:
cd bindings/python && maturin develop # install effect-log from source
pip install langchain-core langchain-openai langgraph # install LangGraph
pip install ai-effectlog langchain-core langchain-openai langgraph

Set your API key:
export OPENAI_API_KEY="sk-..."
Expand Down
3 changes: 1 addition & 2 deletions examples/e2e_openai_agents.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
End-to-end OpenAI Agents SDK + effect-log example.

Setup:
cd bindings/python && maturin develop # install effect-log from source
pip install openai-agents # install the OpenAI Agents SDK
pip install ai-effectlog openai-agents

Set your API key:
export OPENAI_API_KEY="sk-..."
Expand Down
2 changes: 1 addition & 1 deletion examples/langgraph_integration.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This example runs standalone. With langchain-core/langgraph installed,
you can also use the middleware wrappers shown in comments.

pip install effect-log langchain-core langgraph
pip install ai-effectlog langchain-core langgraph
"""

import os
Expand Down
2 changes: 1 addition & 1 deletion examples/openai_agents_integration.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This example runs standalone. With openai-agents installed,
you can also use the middleware wrappers shown in comments.

pip install effect-log openai-agents
pip install ai-effectlog openai-agents
"""

import os
Expand Down
Loading