Skip to main content

Modular Python framework for building AI agents with persistent memory

Project description

Karo Framework

PyPI version License

Karo is a modular Python framework designed for building robust and maintainable AI agent applications. It emphasizes:

  • Modularity: Construct agents from reusable components (core logic, memory, tools).
  • Predictability: Define clear agent interactions using Pydantic schemas.
  • Memory: Equip agents with persistent memory using vector stores like ChromaDB.
  • Extensibility: Easily integrate various LLM providers and custom tools.
  • Control: Maintain fine-grained control over agent behavior and data flow.

Inspired by frameworks like Atomic Agents, Karo aims to provide developers with the building blocks needed for creating sophisticated, reliable AI agents.

Key Features

  • Schema-Driven Development: Use Pydantic for defining agent inputs, outputs, and tool parameters.
  • Provider Abstraction: Pluggable interface for different LLM providers (OpenAI included).
  • Persistent Memory: Built-in MemoryManager using ChromaDBService for storing and retrieving relevant context.
  • Tool Integration: Define and integrate custom tools for agents to use.
  • Pythonic Control Flow: All agent logic and orchestration is written in Python.

Installation

pip install karo

See the full Installation Guide for details on setting up dependencies and environment variables (like OPENAI_API_KEY).

Quickstart

Here's a minimal example of creating a basic agent:

import os
from dotenv import load_dotenv
from karo.core.base_agent import BaseAgent, BaseAgentConfig
from karo.providers.openai_provider import OpenAIProvider, OpenAIProviderConfig
from karo.schemas.base_schemas import BaseInputSchema, BaseOutputSchema

# Load API keys from .env file in your project root
load_dotenv()

# Configure provider (requires OPENAI_API_KEY in .env)
provider_config = OpenAIProviderConfig(model="gpt-4o-mini")
provider = OpenAIProvider(config=provider_config)

# Configure agent
agent_config = BaseAgentConfig(provider=provider)
agent = BaseAgent(config=agent_config)

# Run agent
input_data = BaseInputSchema(chat_message="Explain the concept of AI agents briefly.")
result = agent.run(input_data)

if isinstance(result, BaseOutputSchema):
    print(f"Agent: {result.response_message}")
else:
    print(f"Error: {result.error_message}")

For more detailed examples, including memory and tool usage, check out the Quickstart Guide.

Documentation

Full documentation, including guides and API references, can be found in the docs/ directory (or at the hosted documentation site - link TBD).

License

Copyright 2025 Mensterra

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

karo-0.4.1.tar.gz (57.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

karo-0.4.1-py3-none-any.whl (81.6 kB view details)

Uploaded Python 3

File details

Details for the file karo-0.4.1.tar.gz.

File metadata

  • Download URL: karo-0.4.1.tar.gz
  • Upload date:
  • Size: 57.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.3 Darwin/22.6.0

File hashes

Hashes for karo-0.4.1.tar.gz
Algorithm Hash digest
SHA256 d89e306d5de0c68e8ba78fe165560eb5f463db68c54c1cd76b0b3ccc2c65c196
MD5 2b54afa4ebe76b59b60d552a37abf1f4
BLAKE2b-256 93ea2d97e9d717eb6871d2a2353d3c48fc653065c9e8e69268575e752033d815

See more details on using hashes here.

File details

Details for the file karo-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: karo-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 81.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.3 Darwin/22.6.0

File hashes

Hashes for karo-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 23ce73ab73fefded057c8de573f5ae3f0e6baee5a7371efda57ca7983eb60814
MD5 7f0488c7c477a37f0aed7c91b80d7b88
BLAKE2b-256 12bf5a22a7c14bc23a7dedcf0ade9b19b6b9d3b911d887d30eaede45d9a1bfa9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page