From eed260f577c0c62653db4e2e2f8b24030c3629fb Mon Sep 17 00:00:00 2001 From: Aksh Parekh Date: Fri, 3 Oct 2025 19:32:23 -0700 Subject: [PATCH] Update ma_swarm.md --- docs/examples/ma_swarm.md | 39 +++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/docs/examples/ma_swarm.md b/docs/examples/ma_swarm.md index a016a6b3..3eb40777 100644 --- a/docs/examples/ma_swarm.md +++ b/docs/examples/ma_swarm.md @@ -18,30 +18,37 @@ The `MAAdvisorySwarm` operates as a **sequential workflow**, where each agent's To set up and run the M&A Advisory 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 -### Setup + # Install environment and logging dependencies + pip install python-dotenv loguru - **Set up Exa API Key:** - The `Market & Strategic Analysis 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: + # 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 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/apps/` directory and run the `ma_advisory.py` script. - -```bash -python examples/demos/apps/ma_advisory.py -``` + Replace `"YOUR_EXA_API_KEY"` & `"OPENAI_API_KEY"` with your actual API keys. -OR, you can execute the following Python code directly (ensure all dependencies and the `.env` file are correctly set up): +## Step 2: Running the Mergers & Acquisitions Advisory Swarm ```python from typing import List