base-agent 0.1.0

An abstract base class for building various agent-based systems.

BaseAgent

BaseAgent is an abstract base class designed to support the development of various agent-based systems. It provides a structured approach to creating agents with initialization, execution, and cleanup phases.

Installation

To install BaseAgent, you can use pip directly from GitHub:

pip install git+https://github.com/chigwell/BaseAgent.git

Usage

BaseAgent is intended to be subclassed by other classes that implement specific agent behaviors. Here's an example of how to create a concrete agent:

from base_agent import BaseAgent

class MyAgent(BaseAgent):
    def initialize(self, config):
        print("Initializing with config:", config)

    def execute(self, task):
        print("Executing task:", task)
        return "Task Completed"

    def finalize(self):
        print("Cleaning up resources.")

# Example usage
if __name__ == "__main__":
    agent = MyAgent()
    agent.initialize(config={"setting": "value"})
    result = agent.execute(task="Example Task")
    print(result)
    agent.finalize()

This example demonstrates the basic structure of an agent that can be built using the BaseAgent framework.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

License

This project is licensed under the MIT License.