Skip to main content

Persistent Memory for AI Agents | Fast Key-Value Storage with Agent Memory capabilities

Project description

██╗  ██╗███████╗██╗   ██╗██╗██╗   ██╗███████╗██████╗ ██████╗ 
██║ ██╔╝██╔════╝██║   ██║██║██║   ██║██╔════╝██╔══██╗██╔══██╗
█████╔╝ █████╗  ██║   ██║██║██║   ██║███████╗██║  ██║██████╔╝
██╔═██╗ ██╔══╝  ╚██╗ ██╔╝██║██║   ██║╚════██║██║  ██║██╔══██╗
██║  ██╗███████╗ ╚████╔╝ ██║╚██████╔╝███████║██████╔╝██████╔╝
╚═╝  ╚═╝╚══════╝  ╚═══╝  ╚═╝ ╚═════╝ ╚══════╝╚═════╝ ╚═════╝ 

Python Version License Build Status Coverage

KeviusDB

Persistent Memory for AI Agents | Fast Key-Value Storage

KeviusDB is a lightweight, high-performance database designed for AI agents and applications. It combines ordered key-value storage with specialized agent memory capabilities, offering timestamped conversations, session management, context window handling, and intelligent retrieval strategies.

New in v1.1.0: 🧠 Agent Memory Module - Transform your AI agents with persistent, intelligent memory!

🚀 Features

🧠 Agent Memory (NEW!)

  • 💬 Conversation Storage: Timestamped message storage with role tracking
  • 📊 Session Management: Multi-session support with complete isolation
  • 🎯 Smart Retrieval: Recency, importance, and hybrid retrieval strategies
  • 🪟 Context Windows: Automatic token counting and message truncation
  • 📝 Memory Types: Short-term, long-term, and semantic memory categories
  • ⚡ Framework Ready: Integrations for LangChain, LlamaIndex, AutoGen, CrewAI

🗄️ Core Database

  • 🔢 Ordered Storage: Data is automatically stored sorted by key
  • ⚙️ Custom Comparison: Support for custom comparison functions (default, reverse, numeric)
  • 🔧 Basic Operations: Put(key,value), Get(key), Delete(key) with O(log n) performance
  • ⚡ Atomic Batches: Multiple changes in one atomic operation with rollback support
  • 📸 Snapshots: Transient snapshots for consistent data views without blocking writes
  • 🔄 Iteration: Forward and backward iteration with range and prefix support
  • 🗜️ Compression: Automatic LZ4 compression for space efficiency
  • 🔌 Virtual Interface: Customizable filesystem and compression interfaces

📦 Installation

pip install keviusdb

🚀 Quick Start

🧠 Agent Memory

from keviusdb.memory import AgentMemory, MessageRole

# Create agent memory
memory = AgentMemory("agent.db")

# Add conversation messages
memory.add_message(
    role=MessageRole.USER,
    content="What's the weather like?",
    session_id="user_123"
)

memory.add_message(
    role=MessageRole.ASSISTANT,
    content="I don't have real-time weather data, but I can help you find it!",
    session_id="user_123"
)

# Store important facts in semantic memory
memory.add_message(
    role=MessageRole.USER,
    content="My favorite color is blue",
    importance=9.0,
    memory_type=MemoryType.SEMANTIC
)

# Retrieve recent conversation
recent = memory.get_recent(session_id="user_123", limit=10)
for msg in recent:
    print(f"[{msg.role.value}]: {msg.content}")

# Manage context window
from keviusdb.memory import ContextWindowManager

manager = ContextWindowManager(max_tokens=4000, reserve_tokens=500)
messages_dict = [{'role': m.role.value, 'content': m.content} for m in recent]

if manager.can_fit(messages_dict):
    print("Messages fit in context!")
else:
    truncated = manager.truncate(messages_dict)
    print(f"Truncated to {len(truncated)} messages")

# List all sessions
sessions = memory.list_sessions()
for session in sessions:
    print(f"Session {session.session_id}: {session.metadata.message_count} messages")

🗄️ Core Database

from keviusdb import KeviusDB

# Create database (in-memory or persistent)
db = KeviusDB("mydb.kvdb")  # Persistent storage
# db = KeviusDB()           # In-memory storage

# Basic operations
db.put("user:1", "alice")
db.put("user:2", "bob")
value = db.get("user:1")    # Returns "alice"
db.delete("user:2")

# Check existence
if "user:1" in db:
    print("User 1 exists!")

# Atomic batch operations with automatic rollback on error
with db.batch() as batch:
    batch.put("order:1", "pending")
    batch.put("order:2", "completed")
    batch.delete("user:1")

# Create snapshots for consistent views
snapshot = db.snapshot()
for key, value in snapshot:
    print(f"{key}: {value}")

# Iterate over data (forward/backward, with ranges)
for key, value in db.iterate():
    print(f"{key}: {value}")

# Range iteration
for key, value in db.iterate(start="user:", end="user:z"):
    print(f"User: {key} = {value}")

# Prefix iteration
for key, value in db.iterate_prefix("order:"):
    print(f"Order: {key} = {value}")

🔧 Advanced Usage

Custom Comparison Functions

from keviusdb import KeviusDB
from keviusdb.comparison import ReverseComparison, NumericComparison

# Reverse order storage
db = KeviusDB("reverse.kvdb", comparison=ReverseComparison())

# Numeric key sorting
db = KeviusDB("numeric.kvdb", comparison=NumericComparison())

# Custom comparison function
def custom_compare(a: str, b: str) -> int:
    # Your custom logic here
    return (a > b) - (a < b)

db = KeviusDB("custom.kvdb", comparison=custom_compare)

Transactions with Savepoints

with db.batch() as batch:
    batch.put("key1", "value1")
    
    # Create savepoint
    savepoint = batch.savepoint("checkpoint1")
    batch.put("key2", "value2")
    
    # Rollback to savepoint if needed
    if some_condition:
        batch.rollback_to(savepoint)
    
    # Changes are committed when exiting the context

Custom Storage and Compression

from keviusdb.interfaces import FilesystemInterface, CompressionInterface

class MyCustomFilesystem(FilesystemInterface):
    # Implement custom file operations
    pass

class MyCustomCompression(CompressionInterface):
    # Implement custom compression
    pass

db = KeviusDB(
    "custom.kvdb",
    filesystem=MyCustomFilesystem(),
    compression=MyCustomCompression()
)

⚡ Performance

  • O(log n) for basic operations (put, get, delete)
  • O(k) for iteration over k items
  • Memory efficient with automatic LZ4 compression
  • Atomic batches with minimal overhead
  • Persistent storage with efficient serialization

Benchmarks

# Example performance on modern hardware:
# - 100K operations/second for basic operations
# - 50K items/second for batch operations  
# - 10:1 compression ratio for text data

📚 API Reference

Core Operations

Method Description Complexity
put(key, value) Store key-value pair O(log n)
get(key) Retrieve value by key O(log n)
delete(key) Remove key-value pair O(log n)
contains(key) Check if key exists O(log n)
size() Get number of items O(1)
clear() Remove all items O(n)

Batch Operations

Method Description
batch() Create atomic batch context
savepoint(name) Create named savepoint
rollback_to(savepoint) Rollback to savepoint

Iteration

Method Description
iterate(start, end, reverse) Iterate with range
iterate_prefix(prefix) Iterate by prefix
keys() Iterate over keys only
values() Iterate over values only
items() Iterate over key-value pairs

Snapshots

Method Description
snapshot() Create consistent snapshot
snapshot.iterate() Iterate over snapshot

🧪 Testing

Run the comprehensive test suite:

# Run all tests
python -m unittest discover tests

# Run examples
python examples/basic_usage.py
python examples/advanced_usage.py
python examples/test_usage.py
python examples/memory_usage.py

📄 License

This project is licensed under the MIT License MIT.

Acknowledgments

  • Built with sortedcontainers for efficient ordered storage
  • Uses lz4 for fast compression
  • Inspired by modern key-value stores like LevelDB and RocksDB

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

keviusdb-1.1.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.

keviusdb-1.1.0-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

Details for the file keviusdb-1.1.0.tar.gz.

File metadata

  • Download URL: keviusdb-1.1.0.tar.gz
  • Upload date:
  • Size: 31.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.5

File hashes

Hashes for keviusdb-1.1.0.tar.gz
Algorithm Hash digest
SHA256 ac94554730db5bf29ef408a4cc137f49a4530a9b3c11f1b678ecfcb33905c10c
MD5 82d9d10b8fd1fd495969e92bc503d649
BLAKE2b-256 249700f128376181a31d5dd8089cad7c50faa835aa4347eeebb310ca0e5372ac

See more details on using hashes here.

File details

Details for the file keviusdb-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: keviusdb-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 34.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.5

File hashes

Hashes for keviusdb-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 529bed59f033db05b66b972dc457605b3ad31e019f7feb4bc75f81428affd9a5
MD5 499a5e934f788ee67e0404359ec89a80
BLAKE2b-256 d1429a561545c639334e7e2dbbd5b2c77270144640834868527936008ed49dab

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