Project Requirements

• Python >= 3.11

Installation

You can either directly install with pip:

pip install swarmzero

Or can either directly install with poetry:

poetry add swarmzero

Or add it to your requirements.txt file:

...
swarmzero==x.y.z
...

Environment Setup

You need to specify an OPENAI_API_KEY in a .env file in this directory.

Make a copy of the .env.example file and rename it to .env.

Configuration Setup

To use a configuration file with your Agent, follow these steps:

1. Create a Configuration File:

   • Create a TOML or YAML file (e.g., swarmzero_config.toml or swarmzero_config.yaml) in your project directory. (See swarmzero_config_example.toml or swarmzero_config_example.yaml).

2. Create an SDK Context:

   • Create an instance of SDKContext with the path to your configuration file.
   • The SDKContext allows you to manage configurations, resources, and utilities across your SwarmZero Agents more efficiently.

   from swarmzero.sdk_context import SDKContext
   
   sdk_context = SDKContext(config_path="./swarmzero_config.toml")
   # or use a YAML file
   # sdk_context = SDKContext(con...