diff --git a/examples/deployment_solutions/cron_job_examples/cron_job_example.py b/examples/deployment/cron_job_examples/cron_job_example.py similarity index 100% rename from examples/deployment_solutions/cron_job_examples/cron_job_example.py rename to examples/deployment/cron_job_examples/cron_job_example.py diff --git a/examples/deployment_solutions/cron_job_examples/cron_job_figma_stock_swarms_tools_example.py b/examples/deployment/cron_job_examples/cron_job_figma_stock_swarms_tools_example.py similarity index 100% rename from examples/deployment_solutions/cron_job_examples/cron_job_figma_stock_swarms_tools_example.py rename to examples/deployment/cron_job_examples/cron_job_figma_stock_swarms_tools_example.py diff --git a/examples/deployment_solutions/cron_job_examples/crypto_concurrent_cron_example.py b/examples/deployment/cron_job_examples/crypto_concurrent_cron_example.py similarity index 100% rename from examples/deployment_solutions/cron_job_examples/crypto_concurrent_cron_example.py rename to examples/deployment/cron_job_examples/crypto_concurrent_cron_example.py diff --git a/examples/deployment_solutions/cron_job_examples/figma_stock_example.py b/examples/deployment/cron_job_examples/figma_stock_example.py similarity index 100% rename from examples/deployment_solutions/cron_job_examples/figma_stock_example.py rename to examples/deployment/cron_job_examples/figma_stock_example.py diff --git a/examples/deployment_solutions/cron_job_examples/simple_concurrent_crypto_cron.py b/examples/deployment/cron_job_examples/simple_concurrent_crypto_cron.py similarity index 100% rename from examples/deployment_solutions/cron_job_examples/simple_concurrent_crypto_cron.py rename to examples/deployment/cron_job_examples/simple_concurrent_crypto_cron.py diff --git a/examples/deployment_solutions/cron_job_examples/solana_price_tracker.py b/examples/deployment/cron_job_examples/solana_price_tracker.py similarity index 100% rename from examples/deployment_solutions/cron_job_examples/solana_price_tracker.py rename to examples/deployment/cron_job_examples/solana_price_tracker.py diff --git a/examples/deployment_solutions/README.md b/examples/deployment/fastapi/README.md similarity index 60% rename from examples/deployment_solutions/README.md rename to examples/deployment/fastapi/README.md index 8e50ea43..a5abc935 100644 --- a/examples/deployment_solutions/README.md +++ b/examples/deployment/fastapi/README.md @@ -5,15 +5,24 @@ This directory contains practical examples of different deployment strategies fo ## Examples Overview ### FastAPI + Uvicorn + - **File**: `fastapi_agent_api_example.py` + - **Description**: Complete FastAPI application that exposes Swarms agents as REST APIs + - **Use Case**: Creating HTTP endpoints for your agents + - **Requirements**: `requirements.txt` + ### Cron Jobs + - **Directory**: `cron_job_examples/` + - **Description**: Various examples of running agents on schedules + - **Use Case**: Automated, periodic task execution + - **Examples**: Crypto tracking, stock monitoring, data processing ## Quick Start @@ -46,10 +55,12 @@ This directory contains practical examples of different deployment strategies fo Navigate to the `cron_job_examples/` directory for various scheduling examples: -- `cron_job_example.py` - Basic cron job setup -- `crypto_concurrent_cron_example.py` - Concurrent crypto monitoring -- `solana_price_tracker.py` - Solana price tracking -- `figma_stock_example.py` - Stock monitoring with Figma integration +| File Name | Description | +|------------------------------- |------------------------------------------| +| `cron_job_example.py` | Basic cron job setup | +| `crypto_concurrent_cron_example.py` | Concurrent crypto monitoring | +| `solana_price_tracker.py` | Solana price tracking | +| `figma_stock_example.py` | Stock monitoring with Figma integration | ## Testing @@ -62,20 +73,26 @@ python test_fastapi_example.py ## Documentation For detailed guides and documentation, see: + - [Deployment Solutions Overview](../../docs/deployment_solutions/overview.md) + - [FastAPI Agent API Guide](../../docs/deployment_solutions/fastapi_agent_api.md) ## Requirements - Python 3.8+ + - Swarms framework + - FastAPI and Uvicorn (for API examples) + - Required API keys for your chosen models ## Support -If you encounter issues: -1. Check the requirements are installed correctly -2. Verify your API keys are set -3. Check the documentation for detailed setup instructions -4. Review the test script output for debugging information +| Issue Encountered | Troubleshooting Step | +|------------------------------------------|------------------------------------------------------------------| +| Requirements not working | Check the requirements are installed correctly | +| API authentication problems | Verify your API keys are set | +| Setup or usage confusion | Check the documentation for detailed setup instructions | +| Unexpected errors or failures | Review the test script output for debugging information | diff --git a/examples/deployment_solutions/fastapi_agent_api_example.py b/examples/deployment/fastapi/fastapi_agent_api_example.py similarity index 100% rename from examples/deployment_solutions/fastapi_agent_api_example.py rename to examples/deployment/fastapi/fastapi_agent_api_example.py diff --git a/examples/deployment_solutions/requirements.txt b/examples/deployment/fastapi/requirements.txt similarity index 100% rename from examples/deployment_solutions/requirements.txt rename to examples/deployment/fastapi/requirements.txt diff --git a/examples/simulations/agent_map/agent_map_simulation.py b/examples/multi_agent/simulations/agent_map/agent_map_simulation.py similarity index 100% rename from examples/simulations/agent_map/agent_map_simulation.py rename to examples/multi_agent/simulations/agent_map/agent_map_simulation.py diff --git a/examples/simulations/agent_map/hospital_simulation_demo.py b/examples/multi_agent/simulations/agent_map/hospital_simulation_demo.py similarity index 100% rename from examples/simulations/agent_map/hospital_simulation_demo.py rename to examples/multi_agent/simulations/agent_map/hospital_simulation_demo.py diff --git a/examples/simulations/agent_map/v0/README_simulation.md b/examples/multi_agent/simulations/agent_map/v0/README_simulation.md similarity index 100% rename from examples/simulations/agent_map/v0/README_simulation.md rename to examples/multi_agent/simulations/agent_map/v0/README_simulation.md diff --git a/examples/simulations/agent_map/v0/demo_simulation.py b/examples/multi_agent/simulations/agent_map/v0/demo_simulation.py similarity index 100% rename from examples/simulations/agent_map/v0/demo_simulation.py rename to examples/multi_agent/simulations/agent_map/v0/demo_simulation.py diff --git a/examples/simulations/agent_map/v0/example_usage.py b/examples/multi_agent/simulations/agent_map/v0/example_usage.py similarity index 100% rename from examples/simulations/agent_map/v0/example_usage.py rename to examples/multi_agent/simulations/agent_map/v0/example_usage.py diff --git a/examples/simulations/agent_map/v0/simple_hospital_demo.py b/examples/multi_agent/simulations/agent_map/v0/simple_hospital_demo.py similarity index 100% rename from examples/simulations/agent_map/v0/simple_hospital_demo.py rename to examples/multi_agent/simulations/agent_map/v0/simple_hospital_demo.py diff --git a/examples/simulations/agent_map/v0/test_group_conversations.py b/examples/multi_agent/simulations/agent_map/v0/test_group_conversations.py similarity index 100% rename from examples/simulations/agent_map/v0/test_group_conversations.py rename to examples/multi_agent/simulations/agent_map/v0/test_group_conversations.py diff --git a/examples/simulations/agent_map/v0/test_simulation.py b/examples/multi_agent/simulations/agent_map/v0/test_simulation.py similarity index 100% rename from examples/simulations/agent_map/v0/test_simulation.py rename to examples/multi_agent/simulations/agent_map/v0/test_simulation.py diff --git a/examples/simulations/euroswarm_parliament/README.md b/examples/multi_agent/simulations/euroswarm_parliament/README.md similarity index 100% rename from examples/simulations/euroswarm_parliament/README.md rename to examples/multi_agent/simulations/euroswarm_parliament/README.md diff --git a/examples/simulations/euroswarm_parliament/__init__.py b/examples/multi_agent/simulations/euroswarm_parliament/__init__.py similarity index 100% rename from examples/simulations/euroswarm_parliament/__init__.py rename to examples/multi_agent/simulations/euroswarm_parliament/__init__.py diff --git a/examples/simulations/euroswarm_parliament/euroswarm_parliament.py b/examples/multi_agent/simulations/euroswarm_parliament/euroswarm_parliament.py similarity index 100% rename from examples/simulations/euroswarm_parliament/euroswarm_parliament.py rename to examples/multi_agent/simulations/euroswarm_parliament/euroswarm_parliament.py diff --git a/examples/simulations/euroswarm_parliament/euroswarm_parliament_example.py b/examples/multi_agent/simulations/euroswarm_parliament/euroswarm_parliament_example.py similarity index 100% rename from examples/simulations/euroswarm_parliament/euroswarm_parliament_example.py rename to examples/multi_agent/simulations/euroswarm_parliament/euroswarm_parliament_example.py diff --git a/examples/simulations/euroswarm_parliament/mass_agent_template.py b/examples/multi_agent/simulations/euroswarm_parliament/mass_agent_template.py similarity index 100% rename from examples/simulations/euroswarm_parliament/mass_agent_template.py rename to examples/multi_agent/simulations/euroswarm_parliament/mass_agent_template.py diff --git a/examples/simulations/euroswarm_parliament/test_mass_agents.py b/examples/multi_agent/simulations/euroswarm_parliament/test_mass_agents.py similarity index 100% rename from examples/simulations/euroswarm_parliament/test_mass_agents.py rename to examples/multi_agent/simulations/euroswarm_parliament/test_mass_agents.py diff --git a/examples/simulations/euroswarm_parliament/wikipedia_personality_scraper.py b/examples/multi_agent/simulations/euroswarm_parliament/wikipedia_personality_scraper.py similarity index 100% rename from examples/simulations/euroswarm_parliament/wikipedia_personality_scraper.py rename to examples/multi_agent/simulations/euroswarm_parliament/wikipedia_personality_scraper.py diff --git a/examples/simulations/example_bell_labs.py b/examples/multi_agent/simulations/example_bell_labs.py similarity index 100% rename from examples/simulations/example_bell_labs.py rename to examples/multi_agent/simulations/example_bell_labs.py diff --git a/examples/simulations/map_generation/game_map.py b/examples/multi_agent/simulations/map_generation/game_map.py similarity index 100% rename from examples/simulations/map_generation/game_map.py rename to examples/multi_agent/simulations/map_generation/game_map.py diff --git a/examples/simulations/map_generation/map.png b/examples/multi_agent/simulations/map_generation/map.png similarity index 100% rename from examples/simulations/map_generation/map.png rename to examples/multi_agent/simulations/map_generation/map.png diff --git a/examples/simulations/map_generation/map_two.png b/examples/multi_agent/simulations/map_generation/map_two.png similarity index 100% rename from examples/simulations/map_generation/map_two.png rename to examples/multi_agent/simulations/map_generation/map_two.png diff --git a/examples/simulations/senator_assembly/add_remaining_senators.py b/examples/multi_agent/simulations/senator_assembly/add_remaining_senators.py similarity index 100% rename from examples/simulations/senator_assembly/add_remaining_senators.py rename to examples/multi_agent/simulations/senator_assembly/add_remaining_senators.py diff --git a/examples/simulations/senator_assembly/add_remaining_senators_batch.py b/examples/multi_agent/simulations/senator_assembly/add_remaining_senators_batch.py similarity index 100% rename from examples/simulations/senator_assembly/add_remaining_senators_batch.py rename to examples/multi_agent/simulations/senator_assembly/add_remaining_senators_batch.py diff --git a/examples/simulations/senator_assembly/complete_senator_list.py b/examples/multi_agent/simulations/senator_assembly/complete_senator_list.py similarity index 100% rename from examples/simulations/senator_assembly/complete_senator_list.py rename to examples/multi_agent/simulations/senator_assembly/complete_senator_list.py diff --git a/examples/simulations/senator_assembly/remaining_senators_data.py b/examples/multi_agent/simulations/senator_assembly/remaining_senators_data.py similarity index 100% rename from examples/simulations/senator_assembly/remaining_senators_data.py rename to examples/multi_agent/simulations/senator_assembly/remaining_senators_data.py diff --git a/examples/simulations/senator_assembly/senator_simulation_example.py b/examples/multi_agent/simulations/senator_assembly/senator_simulation_example.py similarity index 100% rename from examples/simulations/senator_assembly/senator_simulation_example.py rename to examples/multi_agent/simulations/senator_assembly/senator_simulation_example.py diff --git a/examples/simulations/senator_assembly/test_concurrent_vote.py b/examples/multi_agent/simulations/senator_assembly/test_concurrent_vote.py similarity index 100% rename from examples/simulations/senator_assembly/test_concurrent_vote.py rename to examples/multi_agent/simulations/senator_assembly/test_concurrent_vote.py