Move to prompts.py

.env.example

@@ -1,3 +1,11 @@
+TAVILY_API_KEY=...
+
+# To separate your traces from other application
+LANGSMITH_PROJECT=retrieval-agent
+
+# The following depend on your selected configuration
+
+## LLM choice:
 ANTHROPIC_API_KEY=....
 FIREWORKS_API_KEY=...
 OPENAI_API_KEY=...

.github/workflows/integration-tests.yml

@@ -0,0 +1,44 @@
+# This workflow will run integration tests for the current project once per day
+
+name: Integration Tests
+
+on:
+  schedule:
+    - cron: "37 14 * * *" # Run at 7:37 AM Pacific Time (14:37 UTC) every day
+  workflow_dispatch: # Allows triggering the workflow manually in GitHub UI
+
+# If another scheduled run starts while this workflow is still running,
+# cancel the earlier run in favor of the next run.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  integration-tests:
+    name: Integration Tests
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.11", "3.12"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          uv venv
+          uv pip install -r pyproject.toml
+          uv pip install -U pytest-asyncio vcrpy
+      - name: Run integration tests
+        env:
+          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+          TAVILY_API_KEY: ${{ secrets.TAVILY_API_KEY }}
+          LANGSMITH_API_KEY: ${{ secrets.LANGSMITH_API_KEY }}
+          LANGSMITH_TRACING: true
+          LANGSMITH_TEST_CACHE: tests/casettes
+        run: |
+          uv run pytest tests/integration_tests

.github/workflows/unit-tests.yml

@@ -0,0 +1,57 @@
+# This workflow will run unit tests for the current project
+
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+  workflow_dispatch: # Allows triggering the workflow manually in GitHub UI
+
+# If another push to the same PR or branch happens while this workflow is still running,
+# cancel the earlier run in favor of the next run.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  unit-tests:
+    name: Unit Tests
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.11", "3.12"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          uv venv
+          uv pip install -r pyproject.toml
+      - name: Lint with ruff
+        run: |
+          uv pip install ruff
+          uv run ruff check .
+      - name: Lint with mypy
+        run: |
+          uv pip install mypy
+          uv run mypy --strict src/
+      - name: Check README spelling
+        uses: codespell-project/actions-codespell@v2
+        with:
+          ignore_words_file: .codespellignore
+          path: README.md
+      - name: Check code spelling
+        uses: codespell-project/actions-codespell@v2
+        with:
+          ignore_words_file: .codespellignore
+          path: src/
+      - name: Run tests with pytest
+        run: |
+          uv pip install pytest
+          uv run pytest tests/unit_tests

README.md

@@ -1,33 +1,118 @@
 # LangGraph ReAct Agent Template
 
-This LangGraph template implements a simple, extensible ReAct agent.
+[![CI](https://github.com/langchain-ai/react-agent/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/langchain-ai/react-agent/actions/workflows/unit-tests.yml)
+[![Integration Tests](https://github.com/langchain-ai/react-agent/actions/workflows/integration-tests.yml/badge.svg)](https://github.com/langchain-ai/react-agent/actions/workflows/integration-tests.yml)
+
+This template showcases a [ReAct agent](https://arxiv.org/abs/2210.03629) implemented using [LangGraph](https://github.com/langchain-ai/langgraph), designed for [LangGraph Studio](https://github.com/langchain-ai/langgraph-studio). ReAct agents are uncomplicated, prototypical agents that can be flexibly extended to many tools.
 
 ![Graph view in LangGraph studio UI](./static/studio_ui.png)
 
-## Repo Structure
-
-```txt
-├── LICENSE
-├── README.md
-├── langgraph.json
-├── poetry.lock
-├── pyproject.toml
-├── react_agent
-│   ├── __init__.py
-│   ├── graph.py
-│   └── utils
-│       ├── __init__.py
-│       ├── configuration.py # Define the configurable variables
-│       ├── state.py # Define state variables and how they're updated
-│       ├── tools.py # Define the tools your agent can access
-│       └── utils.py # Other sundry utilities
-└── tests # Add whatever tests you'd like here
-    ├── integration_tests
-    │   └── __init__.py
-    └── unit_tests
-        └── __init__.py
+The core logic, defined in `src/react_agent/graph.py`, demonstrates a flexible ReAct agent that iteratively reasons about user queries and executes actions, showcasing the power of this approach for complex problem-solving tasks.
+
+## What it does
+
+The ReAct agent:
+
+1. Takes a user **query** as input
+2. Reasons about the query and decides on an action
+3. Executes the chosen action using available tools
+4. Observes the result of the action
+5. Repeats steps 2-4 until it can provide a final answer
+
+By default, it's set up with a basic set of tools, but can be easily extended with custom tools to suit various use cases.
+
+## Getting Started
+
+Assuming you have already [installed LangGraph Studio](https://github.com/langchain-ai/langgraph-studio?tab=readme-ov-file#download), to set up:
+
+1. Create a `.env` file.
+
+```bash
+cp .env.example .env
+```
+
+2. Define required API keys in your `.env` file.
+
+The primary [search tool](./src/react_agent/tools.py) [^1] used is [Tavily](https://tavily.com/). Create an API key [here](https://app.tavily.com/sign-in).
+
+<!--
+Setup instruction auto-generated by `langgraph template lock`. DO NOT EDIT MANUALLY.
+-->
+
+<details>
+<summary>Setup for `model_name` and `scraper_tool_model_name`</summary>
+The `llm` configuration defaults are shown below:
+
+```yaml
+model_name: anthropic/claude-3-5-sonnet-20240620
+scraper_tool_model_name: accounts/fireworks/models/firefunction-v2
+```
+
+Follow the instructions below to get set up, or pick one of the additional options.
+
+### Anthropic Chat Models
+
+To use Anthropic's chat models:
+
+1. Sign up for an [Anthropic API key](https://console.anthropic.com/) if you haven't already.
+2. Once you have your API key, add it to your `.env` file:
+
+```
+ANTHROPIC_API_KEY=your-api-key
+```
+### Fireworks Chat Models
+
+To use Fireworks AI's chat models:
+
+1. Sign up for a [Fireworks AI account](https://app.fireworks.ai/signup) and obtain an API key.
+2. Add your Fireworks AI API key to your `.env` file:
+
+```
+FIREWORKS_API_KEY=your-api-key
+```
+#### OpenAI Chat Models
+
+To use OpenAI's chat models:
+
+1. Sign up for an [OpenAI API key](https://platform.openai.com/signup).
+2. Once you have your API key, add it to your `.env` file:
+```
+OPENAI_API_KEY=your-api-key
 ```
 
+</details>
+
+
+
+<!--
+End setup instructions
+-->
+
+
+3. Customize whatever you'd like in the code.
+4. Open the folder LangGraph Studio!
+
+## How to customize
+
+1. **Add new tools**: Extend the agent's capabilities by adding new tools in [tools.py](./src/react_agent/tools.py). These can be any Python functions that perform specific tasks.
+2. **Select a different model**: We default to Anthropic's Claude 3 Sonnet. You can select a compatible chat model using `provider/model-name` via configuration. Example: `openai/gpt-4-turbo-preview`.
+3. **Customize the prompt**: We provide a default system prompt in [configuration.py](./src/react_agent/configuration.py). You can easily update this via configuration in the studio.
+
+You can also quickly extend this template by:
+
+- Modifying the agent's reasoning process in [graph.py](./src/react_agent/graph.py).
+- Adjusting the ReAct loop or adding additional steps to the agent's decision-making process.
+
+## Development
+
+While iterating on your graph, you can edit past state and rerun your app from past states to debug specific nodes. Local changes will be automatically applied via hot reload. Try adding an interrupt before the agent calls tools, updating the default system message in `src/react_agent/configuration.py` to take on a persona, or adding additional nodes and edges!
+
+Follow up requests will be appended to the same thread. You can create an entirely new thread, clearing previous history, using the `+` button in the top right.
+
+You can find the latest (under construction) docs on [LangGraph](https://github.com/langchain-ai/langgraph) here, including examples and other references. Using those guides can help you pick the right patterns to adapt here for your use case.
+
+LangGraph Studio also integrates with [LangSmith](https://smith.langchain.com/) for more in-depth tracing and collaboration with teammates.
+
 <!--
 Configuration auto-generated by `langgraph template lock`. DO NOT EDIT MANUALLY.
 {
@@ -37,7 +122,7 @@ Configuration auto-generated by `langgraph template lock`. DO NOT EDIT MANUALLY.
       "properties": {
         "system_prompt": {
           "type": "string",
-          "default": "You are a helpful AI assistant.\nSystem time: {system_time}"
+          "default": "You are a helpful AI assistant.\n\nSystem time: {system_time}"
         },
         "model_name": {
           "type": "string",
@@ -410,9 +495,13 @@ Configuration auto-generated by `langgraph template lock`. DO NOT EDIT MANUALLY.
               "variables": "OPENAI_API_KEY"
             }
           ]
+        },
+        "max_search_results": {
+          "type": "integer",
+          "default": 10
         }
       }
     }
   }
 }
--->
+-->

pyproject.toml

@@ -15,6 +15,8 @@ dependencies = [
     "langchain>=0.2.14",
     "langchain-fireworks>=0.1.7",
     "python-dotenv>=1.0.1",
+    "langchain-community>=0.2.17",
+    "tavily-python>=0.4.0",
 ]
 
 
@@ -54,5 +56,7 @@ lint.ignore = [
     "D417",
     "E501",
 ]
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D", "UP"]
 [tool.ruff.lint.pydocstyle]
 convention = "google"

src/react_agent/configuration.py

@@ -2,23 +2,41 @@
 
 from __future__ import annotations
 
-from dataclasses import dataclass, fields
+from dataclasses import dataclass, field, fields
 from typing import Annotated, Optional
 
 from langchain_core.runnables import RunnableConfig, ensure_config
 
+from react_agent import prompts
+
 
 @dataclass(kw_only=True)
 class Configuration:
     """The configuration for the agent."""
 
-    system_prompt: str = "You are a helpful AI assistant.\nSystem time: {system_time}"
+    system_prompt: str = field(default=prompts.SYSTEM_PROMPT)
+    """The system prompt to use for the agent's interactions.
+    
+    This prompt sets the context and behavior for the agent.
+    """
+
     model_name: Annotated[str, {"__template_metadata__": {"kind": "llm"}}] = (
         "anthropic/claude-3-5-sonnet-20240620"
     )
+    """The name of the language model to use for the agent's main interactions.
+    
+    Should be in the form: provider/model-name.
+    """
+
     scraper_tool_model_name: Annotated[
         str, {"__template_metadata__": {"kind": "llm"}}
     ] = "accounts/fireworks/models/firefunction-v2"
+    """The name of the language model to use for the web scraping tool.
+    
+    This model is specifically used for summarizing and extracting information from web pages.
+    """
+    max_search_results: int = 10
+    """The maximum number of search results to return for each search query."""
 
     @classmethod
     def from_runnable_config(

src/react_agent/graph.py

@@ -1,4 +1,4 @@
-"""Define a custom  Reasoning and Action agent.
+"""Define a custom Reasoning and Action agent.
 
 Works with a chat model with tool calling support.
 """

src/react_agent/prompts.py

@@ -0,0 +1,5 @@
+"""Default prompts used by the agent."""
+
+SYSTEM_PROMPT = """You are a helpful AI assistant.
+
+System time: {system_time}"""