Skip to main content

Modular Python framework for building AI agents with persistent memory

Project description

Karo Framework

PyPI version

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

Karo is a proprietary (for now) software product by Mensterra. All rights reserved.

This package is provided for use under the terms of a commercial license.
Unauthorized copying, modification, or distribution of the source code is prohibited.

For licensing inquiries, please contact support@mensterra.com.

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.2.0.tar.gz (31.1 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.2.0-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: karo-0.2.0.tar.gz
  • Upload date:
  • Size: 31.1 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.2.0.tar.gz
Algorithm Hash digest
SHA256 44d069ea667ddc0098030810eb5d8a74b7fac01af7ec4d6190321c1bfe85deb8
MD5 33c2caf9048e25d6e7072416b7686e13
BLAKE2b-256 9b64bd7c69ba704c148310cb25017f8c2f6c1f6c5909ada171bb47fb0b01dc3b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: karo-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 43.7 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b7ace87b6e9ce79b92895dd737fab3d72e0b80e251586122536a9dc5476ffc8
MD5 fc0a06d3ea2e07f44a2df4bb1ec543df
BLAKE2b-256 701e03ff02c86b5f38c8e9e2dcc7806d54d805ad335e3e2536a46a02043d831c

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