diff --git a/examples/README.md b/examples/README.md index ef1d645..9c986a1 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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: @@ -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 ``` diff --git a/examples/crewai_integration.py b/examples/crewai_integration.py index cf46c4e..f463a79 100644 --- a/examples/crewai_integration.py +++ b/examples/crewai_integration.py @@ -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 diff --git a/examples/e2e_crewai.py b/examples/e2e_crewai.py index 0aefba8..5a1b4b9 100644 --- a/examples/e2e_crewai.py +++ b/examples/e2e_crewai.py @@ -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-..." diff --git a/examples/e2e_langgraph.py b/examples/e2e_langgraph.py index 90e7584..43fee37 100644 --- a/examples/e2e_langgraph.py +++ b/examples/e2e_langgraph.py @@ -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-..." diff --git a/examples/e2e_openai_agents.py b/examples/e2e_openai_agents.py index 055b04f..807067a 100644 --- a/examples/e2e_openai_agents.py +++ b/examples/e2e_openai_agents.py @@ -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-..." diff --git a/examples/langgraph_integration.py b/examples/langgraph_integration.py index 77531ad..9f0ae12 100644 --- a/examples/langgraph_integration.py +++ b/examples/langgraph_integration.py @@ -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 diff --git a/examples/openai_agents_integration.py b/examples/openai_agents_integration.py index 13bd2db..15eaa46 100644 --- a/examples/openai_agents_integration.py +++ b/examples/openai_agents_integration.py @@ -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