From 85e2173545465b0585f2874fac7b37ef8634b845 Mon Sep 17 00:00:00 2001 From: Aksh Parekh Date: Fri, 3 Oct 2025 19:36:05 -0700 Subject: [PATCH] Update realestate_swarm.md --- docs/examples/realestate_swarm.md | 34 +++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/docs/examples/realestate_swarm.md b/docs/examples/realestate_swarm.md index b77ca0f9..0a2498fb 100644 --- a/docs/examples/realestate_swarm.md +++ b/docs/examples/realestate_swarm.md @@ -16,25 +16,37 @@ The `RealEstateSwarm` operates as a **sequential workflow**, where each agent's To set up and run the Real Estate Swarm, follow these steps: +## Step 1: Setup and Installation + ### Prerequisites -* Python 3.8+ -* An Exa API Key (for the `exa_search` tool) +| Requirement | +|-----------------------| +| Python 3.8 or higher | +| pip package manager | + +1. **Install dependencies:** + Use the following command to download all dependencies. + ```bash + # Install Swarms framework + pip install swarms + + # Install environment and logging dependencies + pip install python-dotenv loguru -### Setup - **Set up Exa API Key:** + # Install HTTP client and tools + pip install httpx swarms_tools + ``` +2. **Set up API Keys:** The `Property Research Agent` utilizes the `exa_search` tool, which requires an `EXA_API_KEY`. - Create a `.env` file in the root directory of your project (or wherever your application loads environment variables) and add your Exa API key: + Create a `.env` file in the root directory of your project (or wherever your application loads environment variables) and add your API keys: ``` EXA_API_KEY="YOUR_EXA_API_KEY" + OPENAI_API_KEY="OPENAI_API_KEY" ``` - Replace `"YOUR_EXA_API_KEY"` with your actual Exa API key. - -## How to Run - -Navigate to the `examples/demos/real_estate/` directory and run the `realestate_swarm.py` script. + Replace `"YOUR_EXA_API_KEY"` & `"OPENAI_API_KEY"` with your actual API keys. -OR run the following code +## Step 2: Running the Real Estate Swarm ```python