Metadata-Version: 2.4
Name: hippodb-agent-sdk
Version: 1.2.1
Summary: Agent development kit for building self-tuning AI agents with HippoDb biological memory
Author-email: darshana@behaviol.com
Maintainer-email: chamika@behaviol.com, sandun@behaviol.com
License: # PolyForm Noncommercial License 1.0.0
        
        <https://polyformproject.org/licenses/noncommercial/1.0.0>
        
        Required Notice: Copyright 2026 Luthen (https://luthen.ai/)
        
        ## Acceptance
        
        In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
        
        ## Copyright License
        
        The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
        
        ## Distribution License
        
        The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
        
        ## Notices
        
        You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
        
        > Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
        
        ## Changes and New Works License
        
        The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
        
        ## Patent License
        
        The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
        
        ## Noncommercial Purposes
        
        Any noncommercial purpose is a permitted purpose.
        
        ## Personal Uses
        
        Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
        
        ## Noncommercial Organizations
        
        Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
        
        ## Fair Use
        
        You may have "fair use" rights for the software under the law. These terms do not limit them.
        
        ## No Other Rights
        
        These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
        
        ## Patent Defense
        
        If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
        
        ## Violations
        
        The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
        
        ## No Liability
        
        ***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
        
        ## Definitions
        
        The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
        
        **You** refers to the individual or entity agreeing to these terms.
        
        **Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
        
        **Your licenses** are all the licenses granted to you for the software under these terms.
        
        **Use** means anything you do with the software requiring one of your licenses.
        
Project-URL: Homepage, https://luthen.ai/
Keywords: ai-agent,agent-sdk,llm,memory,hippodb,tool-use
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: anthropic>=0.40.0
Requires-Dist: httpx>=0.27.0
Requires-Dist: litellm>=1.83.14
Requires-Dist: pydantic>=2.0.0
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: rich>=13.0.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Provides-Extra: network
Requires-Dist: nats-py>=2.9.0; extra == "network"
Dynamic: license-file

# HippoDb Agent SDK

Python SDK for building self-tuning AI agents backed by HippoDb.

Homepage: [https://luthen.ai/](https://luthen.ai/)

This package is designed for developers who want to build custom agents with:
- an LLM tool-use loop
- persistent memory in HippoDb
- configurable business tools
- optional rule enforcement, tuning, gateway, and networking features

## What This SDK Provides

- `AgentRunner` to boot and run an agent
- `RoleConfig` to define agent identity and prompt behavior
- `BaseTool` to define business-domain tools
- `AgentSettings` to configure runtime behavior
- built-in memory, OS, and calculator tools
- HippoDb-backed memory client and memory seeding support

## Core Concepts

### 1. Role

A role defines what the agent is, which tools it can see, and how it should behave.

### 2. Tools

Tools are Python classes that inherit from `BaseTool`. They are how the agent interacts with external systems.

### 3. Runner

`AgentRunner` wires together the LLM, tools, HippoDb, configuration, and terminal runtime.

### 4. Memory

HippoDb acts as the persistent memory layer for concepts, rules, and conversation continuity.

## Installation

```bash
pip install hippodb-agent-sdk
```

For local development against a source checkout:

```bash
pip install -e .
```

## Configuration

Configuration is loaded from:
1. SDK defaults in `src/hippodb_agent/defaults.env`
2. local `.env`
3. environment variables

Important settings include:
- `LLM_API_KEY`
- `ANTHROPIC_API_KEY`
- `HIPPODB_URL`
- `MODEL`

Example `.env`:

```env
LLM_API_KEY=your_key_here
HIPPODB_URL=http://localhost:7700
MODEL=anthropic/claude-sonnet-4-20250514
```

## Minimal Example

Create a small agent with one custom tool.

### `tools.py`

```python
from hippodb_agent import BaseTool


class HelloTool(BaseTool):
    name = "demo_hello"
    description = "Return a hello message"
    input_schema = {
        "type": "object",
        "properties": {},
        "required": [],
    }

    async def execute(self, inp: dict) -> dict:
        return {"message": "hello from HippoDb Agent SDK"}
```

### `role.py`

```python
from hippodb_agent import RoleConfig


MY_ROLE = RoleConfig(
    name="demo_agent",
    display_name="Demo Agent",
    tool_scopes=["demo_"],
    fabric="demo_agent",
    system_prompt="You are a helpful demo agent.\n\n{manifest}",
)
```

### `main.py`

```python
from hippodb_agent import AgentRunner
from role import MY_ROLE
from tools import HelloTool


runner = AgentRunner(
    role=MY_ROLE,
    business_tools=[HelloTool],
)


if __name__ == "__main__":
    runner.start()
```

Run it with:

```bash
python main.py
```

## Building a New Agent

For a typical agent project, you usually create:
- `tools.py` for business-domain tools
- `role.py` for `RoleConfig`
- `main.py` as the startup entry point
- `seed.yaml` for pre-education
- `test_suite.py` or tests for validation

### Example Tool

```python
from hippodb_agent import BaseTool


class ListEmployees(BaseTool):
    name = "hr_list_employees"
    description = "List all employees"
    input_schema = {"type": "object", "properties": {}, "required": []}
    backend = "hr"

    async def execute(self, inp: dict) -> dict:
        r = await self.api.get("/employees")
        r.raise_for_status()
        return r.json()
```

### Example Runner With Backend

```python
from hippodb_agent import AgentRunner
from role import MY_ROLE
from tools import ListEmployees


runner = AgentRunner(
    role=MY_ROLE,
    business_tools=[ListEmployees],
    api_base_url="http://localhost:9000",
    seed_file="seed.yaml",
)


if __name__ == "__main__":
    runner.start()
```

## Public SDK Surface

The intended primary imports are:

```python
from hippodb_agent import (
    AgentSettings,
    RoleConfig,
    AgentRunner,
    BaseTool,
    ApiClients,
)
```

Additional helper exports currently include:
- `get_os_tools`
- `get_calc_tools`
- `BaseMemoryFormatter`
- `get_formatter`
- `DataGateway`
- `MaskStrategy`
- `FieldPolicy`
- `AgentNetwork`

## Runtime Behavior

Installing this package does not start any worker or background service.

Runtime behavior begins only when your application starts an agent, typically through `AgentRunner.start()`.

Depending on configuration, startup may:
- connect to HippoDb
- create or reuse a fabric
- seed memory from `seed.yaml`
- start internal scheduler tasks
- connect to the optional agent network

## Notes

- This repository currently includes some optional subsystems beyond the core SDK, such as networking, gateway/compliance, tuning, monitoring, and sleep orchestration.
- The primary use of the package is as an SDK for building custom agents.
- Bundled utility applications may exist in the repository, but they are not required for SDK usage.

## Development

Useful local commands:

```bash
pip install -e .[dev]
pytest
```

## License

This SDK is distributed under the **PolyForm Noncommercial License 1.0.0**. In short:

- Free to install, run, modify, and evaluate for any noncommercial purpose (personal projects, research, internal evaluation, etc.)
- Any commercial use requires a separate license from us.

See [LICENSE](LICENSE) for the full terms.

For commercial licensing inquiries, contact **darshana@behaviol.com**.

This technology is created and owned by Behaviol Pvt Ltd, distributed under the product name Luthen ([https://luthen.ai/](https://luthen.ai/)).
