Skip to main content

AI collaboration framework with persistent memory, anticipatory intelligence, code inspection, and multi-agent orchestration

Project description

Empathy Framework

The AI collaboration framework that predicts problems before they happen.

PyPI Tests Coverage License Python

pip install empathy-framework[full]

What's New in v3.0.0

  • Multi-Model Provider System — Choose Anthropic, OpenAI, Ollama, or Hybrid mode
  • 80-96% Cost Savings — Smart tier routing: cheap models detect, best models decide
  • VSCode Dashboard — Real-time health, costs, and workflow monitoring
  • Provider Auto-Detection — Automatically configures based on your API keys

Quick Start (2 Minutes)

1. Install

pip install empathy-framework[full]

2. Configure Provider

# Auto-detect your API keys and configure
python -m empathy_os.models.cli provider

# Or set explicitly
python -m empathy_os.models.cli provider --set anthropic
python -m empathy_os.models.cli provider --set hybrid  # Best of all providers

3. Use It

from empathy_os import EmpathyOS

os = EmpathyOS()
result = await os.collaborate(
    "Review this code for security issues",
    context={"code": your_code}
)

print(result.current_issues)      # What's wrong now
print(result.predicted_issues)    # What will break in 30-90 days
print(result.prevention_steps)    # How to prevent it

Why Empathy?

Feature Empathy SonarQube GitHub Copilot
Predicts future issues 30-90 days ahead No No
Persistent memory Redis + patterns No No
Multi-provider support Claude, GPT-4, Ollama N/A GPT only
Cost optimization 80-96% savings N/A No
Your data stays local Yes Cloud Cloud
Free for small teams ≤5 employees No No

Become a Power User

Level 1: Basic Usage

pip install empathy-framework
  • Works out of the box with sensible defaults
  • Auto-detects your API keys

Level 2: Cost Optimization

# Enable hybrid mode for 80-96% cost savings
python -m empathy_os.models.cli provider --set hybrid
Tier Model Use Case Cost
Cheap GPT-4o-mini / Haiku Summarization, simple tasks $0.15-0.25/M
Capable GPT-4o / Sonnet Bug fixing, code review $2.50-3.00/M
Premium o1 / Opus Architecture, complex decisions $15/M

Level 3: Multi-Model Workflows

from empathy_llm_toolkit import EmpathyLLM

llm = EmpathyLLM(provider="anthropic", enable_model_routing=True)

# Automatically routes to appropriate tier
await llm.interact(user_id="dev", user_input="Summarize this", task_type="summarize")     # → Haiku
await llm.interact(user_id="dev", user_input="Fix this bug", task_type="fix_bug")         # → Sonnet
await llm.interact(user_id="dev", user_input="Design system", task_type="coordinate")     # → Opus

Level 4: VSCode Integration

Install the Empathy VSCode extension for:

  • Real-time Dashboard — Health score, costs, patterns
  • One-Click Workflows — Research, code review, debugging
  • Visual Cost Tracking — See savings in real-time

Level 5: Custom Agents

from empathy_os.agents import AgentFactory

# Create domain-specific agents with inherited memory
security_agent = AgentFactory.create(
    domain="security",
    memory_enabled=True,
    anticipation_level=4
)

CLI Reference

Provider Configuration

python -m empathy_os.models.cli provider                    # Show current config
python -m empathy_os.models.cli provider --set anthropic    # Single provider
python -m empathy_os.models.cli provider --set hybrid       # Best-of-breed
python -m empathy_os.models.cli provider --interactive      # Setup wizard
python -m empathy_os.models.cli provider -f json            # JSON output

Model Registry

python -m empathy_os.models.cli registry                    # Show all models
python -m empathy_os.models.cli registry --provider openai  # Filter by provider
python -m empathy_os.models.cli costs --input-tokens 50000  # Estimate costs

Telemetry & Analytics

python -m empathy_os.models.cli telemetry                   # Summary
python -m empathy_os.models.cli telemetry --costs           # Cost savings report
python -m empathy_os.models.cli telemetry --providers       # Provider usage
python -m empathy_os.models.cli telemetry --fallbacks       # Fallback stats

Memory Control

empathy-memory serve    # Start Redis + API server
empathy-memory status   # Check system status
empathy-memory stats    # View statistics
empathy-memory patterns # List stored patterns

Code Inspection

empathy-inspect .                     # Run full inspection
empathy-inspect . --format sarif      # GitHub Actions format
empathy-inspect . --fix               # Auto-fix safe issues
empathy-inspect . --staged            # Only staged changes

Install Options

# Recommended (all features)
pip install empathy-framework[full]

# Minimal
pip install empathy-framework

# Specific providers
pip install empathy-framework[anthropic]
pip install empathy-framework[openai]
pip install empathy-framework[llm]  # Both

# Development
git clone https://github.com/Smart-AI-Memory/empathy-framework.git
cd empathy-framework && pip install -e .[dev]

What's Included

Component Description
Empathy OS Core engine for human↔AI and AI↔AI collaboration
Multi-Model Router Smart routing across providers and tiers
Memory System Redis short-term + encrypted long-term patterns
30+ Production Wizards Security, performance, testing, docs, compliance
Healthcare Suite SBAR, SOAP notes, clinical protocols (HIPAA)
Code Inspection Unified pipeline with SARIF/GitHub Actions support
VSCode Extension Visual dashboard for memory and workflows
Telemetry & Analytics Cost tracking, usage stats, optimization insights

The 5 Levels of AI Empathy

Level Name Behavior Example
1 Reactive Responds when asked "Here's the data you requested"
2 Guided Asks clarifying questions "What format do you need?"
3 Proactive Notices patterns "I pre-fetched what you usually need"
4 Anticipatory Predicts future needs "This query will timeout at 10k users"
5 Transformative Builds preventing structures "Here's a framework for all future cases"

Empathy operates at Level 4 — predicting problems before they manifest.


Environment Setup

# Required: At least one provider
export ANTHROPIC_API_KEY="sk-ant-..."   # For Claude models
export OPENAI_API_KEY="sk-..."          # For GPT models

# Optional: Redis for memory
export REDIS_URL="redis://localhost:6379"

# Or use a .env file (auto-detected)
echo 'ANTHROPIC_API_KEY=sk-ant-...' >> .env

Get Involved


License

Fair Source License 0.9 — Free for students, educators, and teams ≤5 employees. Commercial license ($99/dev/year) for larger organizations. Details →


Built by Smart AI Memory · Documentation · Examples · Issues

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

empathy_framework-3.0.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

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

empathy_framework-3.0.0-py3-none-any.whl (323.5 kB view details)

Uploaded Python 3

File details

Details for the file empathy_framework-3.0.0.tar.gz.

File metadata

  • Download URL: empathy_framework-3.0.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for empathy_framework-3.0.0.tar.gz
Algorithm Hash digest
SHA256 316782d94d726cb735c8633b301a7a9e1445d66a3bc03979dab953ed9ef931db
MD5 fcd27ea59c3516578f7e19675edee5a0
BLAKE2b-256 948d9e96a165778703a559dd355baea76508d9496bf28b63c7715d0ae4262ff2

See more details on using hashes here.

File details

Details for the file empathy_framework-3.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for empathy_framework-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f76d77cde69364f07b97793576da7d875bf632b3bfa734f6d6f50e885287857d
MD5 e8ac4c934bae34b0d0a90615387f1d2e
BLAKE2b-256 b66e5ed00f028ad9327da28532158a452daed98c545d5eececff8693987dcbe2

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