AI Agent Framework

This project provides a framework for defining and running AI agent-based workflows. It allows users to define a series of tasks in a YAML file and then execute them using a variety of AI agents.

Getting Started

Prerequisites

• Python 3.x
• pip

Installation

1. Clone the repository:

   git clone <repository-url>
   cd <repository-directory>

2. Install the required dependencies:

   pip install -r requirements.txt

Running a Workflow

To run a workflow, use the run command and specify the path to your workflow YAML file:

python main.py run workflows/simple_workflow.yaml

Project Structure

• src/: The main source code for the framework.
  • agents/: Contains the different AI agent implementations.
  • workflow/: Components for loading and managing workflows.
  • cli.py: Defines the command-line interface.
  • main.py: The main entry point of the application.
• workflows/: Contains example workflow YAML files.
• tests/: Contains the test suite for the project.
• requirements.txt: A list of the Python packages required to run the project.

Architecture

For a more detailed explanation of the project's architecture, please see the ARCHITECTURE.md file.

How to Contribute

For more detailed contribution guidelines, please see the CONTRIBUTING.md file.

We welcome contributions to this project! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix:

   git checkout -b feature/your-feature-name

3. Make your changes and commit them with clear, descriptive messages.
4. Run the tests to ensure that your changes don't break anything:

   pytest

5. Push your branch to your fork:

   git push origin feature/your-feature-name

6. Create a pull request to the main branch of the original repository.

License

This project is licensed under the MIT License. See the LICENSE file for more details.