empathy-framework 3.5.5__tar.gz → 3.5.6__tar.gz

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: empathy-framework
-Version: 3.5.5
+Version: 3.5.6
 Summary: AI collaboration framework with persistent memory, anticipatory intelligence, code inspection, and multi-agent orchestration
 Author-email: Patrick Roebuck <patrick.roebuck@smartAImemory.com>
 Maintainer-email: Smart-AI-Memory <patrick.roebuck@smartAImemory.com>

empathy_framework-3.5.6/docs/guides/WORKFLOW_PATTERNS.md

@@ -0,0 +1,235 @@
+# Workflow Patterns Guide
+
+This guide helps you choose the right workflow pattern for your use case. The Empathy Framework supports three patterns, each optimized for different scenarios.
+
+## Quick Decision
+
+**Default: Crew** - Unless you have a specific reason to choose otherwise.
+
+```bash
+empathy workflow new my-workflow           # Crew (default, recommended)
+empathy workflow new my-workflow --base    # Base pattern
+empathy workflow new my-workflow --compose # Composition pattern
+```
+
+---
+
+## The Three Patterns
+
+### 1. Crew Pattern (Default)
+
+**What it is:** Multiple specialized AI agents collaborate on a task, each bringing domain expertise.
+
+**Best for:**
+- Analysis tasks requiring multiple perspectives
+- Quality-critical workflows where thoroughness matters
+- Tasks that benefit from debate/consensus (security audits, code reviews)
+
+**Trade-offs:**
+| Pros | Cons |
+|------|------|
+| Richer, more thorough analysis | Higher cost (multiple agents) |
+| Multiple perspectives catch more issues | Longer execution time |
+| Self-correcting through agent discussion | More complex to debug |
+
+**Example from codebase:** `SecurityAuditCrew` - 5 agents (SecurityAnalyst, CodeReviewer, PentestExpert, ComplianceChecker, ReportWriter) collaborate on security analysis.
+
+**When NOT to use:**
+- Simple, single-purpose tasks
+- Cost-sensitive batch operations
+- When speed matters more than thoroughness
+
+---
+
+### 2. Base Pattern
+
+**What it is:** Sequential stages with automatic model tier routing for cost optimization.
+
+**Best for:**
+- Single-purpose workflows with clear stages
+- Cost-sensitive operations
+- Tasks where stages naturally build on each other
+
+**Trade-offs:**
+| Pros | Cons |
+|------|------|
+| Cost-optimized (tier routing) | Single perspective |
+| Predictable execution flow | Less thorough than crew |
+| Built-in telemetry/progress tracking | Sequential only |
+
+**Example from codebase:** `TestGenerationWorkflow` - stages: identify → analyze → generate → format
+
+```python
+class MyWorkflow(BaseWorkflow):
+    def define_steps(self) -> list[WorkflowStepConfig]:
+        return [
+            WorkflowStepConfig(
+                name="analyze",
+                tier=ModelTier.CAPABLE,  # Routes to Sonnet/GPT-4o
+                prompt_template="Analyze: {input}"
+            ),
+            WorkflowStepConfig(
+                name="summarize",
+                tier=ModelTier.CHEAP,    # Routes to Haiku/GPT-4o-mini
+                prompt_template="Summarize: {previous_output}"
+            ),
+        ]
+```
+
+**When NOT to use:**
+- Orchestrating multiple existing workflows
+- Tasks requiring parallel execution
+- When you need multi-agent collaboration
+
+---
+
+### 3. Composition Pattern
+
+**What it is:** Orchestrate multiple existing workflows, optionally in parallel.
+
+**Best for:**
+- Meta-workflows that combine existing capabilities
+- Parallel execution of independent analyses
+- Custom result aggregation across workflows
+
+**Trade-offs:**
+| Pros | Cons |
+|------|------|
+| Reuse existing workflows | No built-in tier routing |
+| Parallel execution possible | Manual cost aggregation |
+| Flexible orchestration | More boilerplate |
+
+**Example from codebase:** `SecureReleasePipeline` - orchestrates SecurityAuditWorkflow + CodeReviewWorkflow + ReleasePreparationWorkflow
+
+```python
+class MyPipeline:
+    async def execute(self, path: str) -> PipelineResult:
+        # Run in parallel
+        security_task = asyncio.create_task(
+            SecurityAuditWorkflow().execute(path)
+        )
+        review_task = asyncio.create_task(
+            CodeReviewWorkflow().execute(path)
+        )
+
+        security_result, review_result = await asyncio.gather(
+            security_task, review_task
+        )
+
+        return self._aggregate_results(security_result, review_result)
+```
+
+**When NOT to use:**
+- Building a new standalone capability
+- When you need tier-based cost optimization
+- Simple single-stage tasks
+
+---
+
+## Decision Tree
+
+```
+Start
+  │
+  ├─ "Am I combining 2+ existing workflows?"
+  │     └─ Yes → Composition
+  │     └─ No ↓
+  │
+  ├─ "Do I need multiple AI perspectives?"
+  │     └─ Yes → Crew (default)
+  │     └─ No ↓
+  │
+  └─ "Is this a sequential, cost-sensitive task?"
+        └─ Yes → Base
+        └─ No → Crew (default)
+```
+
+---
+
+## Configuration
+
+Set your project's default pattern in `empathy.config.yml`:
+
+```yaml
+workflow:
+  default_pattern: crew  # crew | base | compose
+
+  crew:
+    default_agents: 3    # Cost/quality tradeoff
+    timeout_seconds: 300
+
+  base:
+    default_tier: capable  # cheap | capable | premium
+    enable_telemetry: true
+```
+
+Override per-workflow:
+
+```bash
+# Use base pattern even though project defaults to crew
+empathy workflow new cost-sensitive-task --base
+```
+
+---
+
+## Migration Paths
+
+### Base → Crew
+When your Base workflow needs richer analysis:
+
+1. Identify the different "perspectives" your workflow should have
+2. Create agent definitions for each perspective
+3. Replace `define_steps()` with agent collaboration logic
+
+### Crew → Composition
+When you want to reuse your Crew alongside other workflows:
+
+1. Keep your Crew as-is
+2. Create a new Composition wrapper
+3. Call your Crew from the composition alongside other workflows
+
+### Composition → Base
+When your composed workflows should be a single optimized pipeline:
+
+1. Identify the core stages from each sub-workflow
+2. Merge into a single `define_steps()` with tier routing
+3. Remove the composition wrapper
+
+---
+
+## Comparison Table
+
+| Aspect | Crew | Base | Compose |
+|--------|------|------|---------|
+| **Default** | ✅ Yes | No | No |
+| **Cost** | High | Low-Medium | Varies |
+| **Thoroughness** | High | Medium | Depends |
+| **Speed** | Slow | Fast | Varies |
+| **Complexity** | Medium | Low | Medium |
+| **Parallelism** | Agent-level | No | Workflow-level |
+| **Tier Routing** | No | Yes | Manual |
+| **Telemetry** | Manual | Built-in | Manual |
+
+---
+
+## Examples from Empathy Framework
+
+| Workflow | Pattern | Why |
+|----------|---------|-----|
+| `SecurityAuditCrew` | Crew | Multiple security perspectives needed |
+| `TestGenerationWorkflow` | Base | Sequential stages, cost-sensitive |
+| `SecureReleasePipeline` | Compose | Orchestrates 4 existing workflows |
+| `CodeReviewWorkflow` | Base | Sequential analysis stages |
+| `ResearchSynthesisWorkflow` | Crew | Multi-document analysis benefits from perspectives |
+
+---
+
+## Summary
+
+1. **Start with Crew** - It's the default for a reason
+2. **Use Base** when cost/speed matters more than thoroughness
+3. **Use Compose** when combining existing workflows
+4. **Configure defaults** in `empathy.config.yml`
+5. **Override per-workflow** with `--base` or `--compose` flags
+
+Questions? See the implementation examples in `src/empathy_os/workflows/`.

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/empathy_framework.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: empathy-framework
-Version: 3.5.5
+Version: 3.5.6
 Summary: AI collaboration framework with persistent memory, anticipatory intelligence, code inspection, and multi-agent orchestration
 Author-email: Patrick Roebuck <patrick.roebuck@smartAImemory.com>
 Maintainer-email: Smart-AI-Memory <patrick.roebuck@smartAImemory.com>

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/empathy_framework.egg-info/SOURCES.txt

@@ -67,6 +67,7 @@ docs/guides/DISTRIBUTION_POLICY.md
 docs/guides/MCP_PUBLISH_INSTRUCTIONS.md
 docs/guides/MKDOCS_TUTORIAL.md
 docs/guides/PUBLISHING.md
+docs/guides/WORKFLOW_PATTERNS.md
 docs/guides/claude-memory-integration.md
 docs/guides/foreword.md
 docs/guides/healthcare-wizards.md

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "empathy-framework"
-version = "3.5.5"
+version = "3.5.6"
 description = "AI collaboration framework with persistent memory, anticipatory intelligence, code inspection, and multi-agent orchestration"
 readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.10"

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/src/empathy_os/cli.py

@@ -1874,8 +1874,17 @@ def cmd_workflow(args):
             if args.input:
                 input_data = json_mod.loads(args.input)
 
-            print(f"\n Running workflow: {name} (provider: {provider})")
-            print("=" * 50)
+            # Add test-gen specific flags to input_data (only for test-gen workflow)
+            if name == "test-gen":
+                if getattr(args, "write_tests", False):
+                    input_data["write_tests"] = True
+                if getattr(args, "output_dir", None):
+                    input_data["output_dir"] = args.output_dir
+
+            # Only print header when not in JSON mode
+            if not args.json:
+                print(f"\n Running workflow: {name} (provider: {provider})")
+                print("=" * 50)
 
             # Execute workflow
             result = asyncio.run(workflow.execute(**input_data))
@@ -1920,9 +1929,29 @@ def cmd_workflow(args):
                         error = metadata.get("error") if isinstance(metadata, dict) else None
 
                 # JSON output includes both content and metadata
+                # Include final_output for programmatic access (VSCode panels, etc.)
+                raw_final_output = getattr(result, "final_output", None)
+                if raw_final_output and isinstance(raw_final_output, dict):
+                    # Make a copy to avoid modifying the original
+                    final_output_serializable = {}
+                    for k, v in raw_final_output.items():
+                        # Skip non-serializable items
+                        if isinstance(v, set):
+                            final_output_serializable[k] = list(v)
+                        elif v is None or isinstance(v, str | int | float | bool | list | dict):
+                            final_output_serializable[k] = v
+                        else:
+                            try:
+                                final_output_serializable[k] = str(v)
+                            except Exception:
+                                pass
+                else:
+                    final_output_serializable = None
+
                 output = {
                     "success": result.success,
                     "output": output_content,
+                    "final_output": final_output_serializable,
                     "cost": total_cost,
                     "savings": savings,
                     "duration_ms": duration_ms or 0,
@@ -2476,6 +2505,16 @@ def main():
         help="Force overwrite existing config file",
     )
     parser_workflow.add_argument("--json", action="store_true", help="Output as JSON")
+    parser_workflow.add_argument(
+        "--write-tests",
+        action="store_true",
+        help="(test-gen workflow) Write generated tests to disk",
+    )
+    parser_workflow.add_argument(
+        "--output-dir",
+        default="tests/generated",
+        help="(test-gen workflow) Output directory for generated tests",
+    )
     parser_workflow.set_defaults(func=cmd_workflow)
 
     # Sync-claude command (sync patterns to Claude Code)

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/src/empathy_os/workflow_commands.py

@@ -347,8 +347,8 @@ def ship_workflow(
         # Import here to avoid circular imports
         try:
             from empathy_llm_toolkit.cli.sync_claude import (
-                sync_patterns_to_claude,  # type: ignore[attr-defined]
-            )
+                sync_patterns_to_claude,
+            )  # type: ignore[attr-defined]
 
             result = sync_patterns_to_claude(
                 patterns_dir=patterns_dir, output_dir=".claude/rules/empathy"

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_agent_orchestration_wizard.py

@@ -18,9 +18,7 @@ from pathlib import Path
 
 import pytest
 
-from empathy_software_plugin.wizards.agent_orchestration_wizard import (
-    AgentOrchestrationWizard,
-)
+from empathy_software_plugin.wizards.agent_orchestration_wizard import AgentOrchestrationWizard
 
 
 class TestAgentOrchestrationWizardInit:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_config_loaders.py

@@ -336,8 +336,7 @@ class TestESLintConfigLoader:
         # Note: The loader's regex extracts JSON from module.exports = {...}
         # It requires strict JSON format (double quotes, no trailing commas)
         js_content = (
-            'module.exports = {"rules": {"no-console": "warn"}, '
-            '"extends": ["eslint:recommended"]};'
+            'module.exports = {"rules": {"no-console": "warn"}, "extends": ["eslint:recommended"]};'
         )
         config_path = Path(temp_dir) / ".eslintrc.js"
         with open(config_path, "w") as f:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_document_gen.py

@@ -14,11 +14,7 @@ from pathlib import Path
 import pytest
 
 from empathy_os.workflows.base import ModelTier
-from empathy_os.workflows.document_gen import (
-    DOC_GEN_STEPS,
-    TOKEN_COSTS,
-    DocumentGenerationWorkflow,
-)
+from empathy_os.workflows.document_gen import DOC_GEN_STEPS, TOKEN_COSTS, DocumentGenerationWorkflow
 
 
 class TestTokenCosts:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_graph.py

@@ -14,12 +14,7 @@ from pathlib import Path
 
 import pytest
 
-from empathy_os.memory.edges import (
-    REVERSE_EDGE_TYPES,
-    WIZARD_EDGE_PATTERNS,
-    Edge,
-    EdgeType,
-)
+from empathy_os.memory.edges import REVERSE_EDGE_TYPES, WIZARD_EDGE_PATTERNS, Edge, EdgeType
 from empathy_os.memory.graph import MemoryGraph
 from empathy_os.memory.nodes import (
     BugNode,

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_performance_profiling_wizard.py

@@ -22,12 +22,8 @@ from empathy_software_plugin.wizards.performance.bottleneck_detector import (
     BottleneckType,
 )
 from empathy_software_plugin.wizards.performance.profiler_parsers import FunctionProfile
-from empathy_software_plugin.wizards.performance.trajectory_analyzer import (
-    TrajectoryPrediction,
-)
-from empathy_software_plugin.wizards.performance_profiling_wizard import (
-    PerformanceProfilingWizard,
-)
+from empathy_software_plugin.wizards.performance.trajectory_analyzer import TrajectoryPrediction
+from empathy_software_plugin.wizards.performance_profiling_wizard import PerformanceProfilingWizard
 
 
 class TestPerformanceProfilingWizardInitialization:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_pr_review.py

@@ -9,11 +9,7 @@ from unittest.mock import AsyncMock, patch
 
 import pytest
 
-from empathy_os.workflows.pr_review import (
-    PRReviewResult,
-    PRReviewWorkflow,
-    format_pr_review_report,
-)
+from empathy_os.workflows.pr_review import PRReviewResult, PRReviewWorkflow, format_pr_review_report
 
 
 class TestPRReviewResult:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_refactor_golden.py

@@ -109,10 +109,9 @@ class TestGoldenScenarioValidation:
         primary = expected["primary_category"]
 
         valid_categories = [c.value for c in RefactoringCategory]
-        assert primary in valid_categories, (
-            f"Invalid primary_category '{primary}' in {scenario}. "
-            f"Valid options: {valid_categories}"
-        )
+        assert (
+            primary in valid_categories
+        ), f"Invalid primary_category '{primary}' in {scenario}. Valid options: {valid_categories}"
 
 
 class TestRefactoringCrewGoldenAnalysis:
@@ -125,10 +124,7 @@ class TestRefactoringCrewGoldenAnalysis:
     @pytest.mark.parametrize("scenario", get_golden_scenarios())
     def test_scenario_analysis_structure(self, scenario: str):
         """Test that analysis produces expected structure for each scenario."""
-        from empathy_llm_toolkit.agent_factory.crews import (
-            RefactoringConfig,
-            RefactoringCrew,
-        )
+        from empathy_llm_toolkit.agent_factory.crews import RefactoringConfig, RefactoringCrew
 
         input_code, expected = load_golden_scenario(scenario)
 

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_registry.py

@@ -12,12 +12,7 @@ Tests the unified model registry including:
 
 import pytest
 
-from empathy_os.models.registry import (
-    MODEL_REGISTRY,
-    ModelInfo,
-    ModelProvider,
-    ModelTier,
-)
+from empathy_os.models.registry import MODEL_REGISTRY, ModelInfo, ModelProvider, ModelTier
 
 
 class TestModelTierEnum:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_sbar_wizard.py

@@ -12,10 +12,7 @@ import pytest
 
 # Try to import the module - skip tests if dependencies unavailable
 try:
-    from wizards_consolidated.healthcare.sbar_wizard import (
-        SBAR_STEPS,
-        router,
-    )
+    from wizards_consolidated.healthcare.sbar_wizard import SBAR_STEPS, router
 
     SBAR_AVAILABLE = True
 except ImportError:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_secure_release.py

@@ -12,10 +12,7 @@ Copyright 2025 Smart AI Memory, LLC
 Licensed under Fair Source 0.9
 """
 
-from src.empathy_os.workflows.secure_release import (
-    SecureReleasePipeline,
-    SecureReleaseResult,
-)
+from src.empathy_os.workflows.secure_release import SecureReleasePipeline, SecureReleaseResult
 
 
 class TestSecureReleaseResult:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_security_learning_wizard.py

@@ -424,7 +424,7 @@ class TestSecurityLearningWizardIntegration:
         """Test full analysis workflow."""
         with tempfile.TemporaryDirectory() as tmpdir:
             # Create file with potential vulnerabilities
-            (Path(tmpdir) / "auth.py").write_text("password = 'secret123'\n" "x = Math.random()\n")
+            (Path(tmpdir) / "auth.py").write_text("password = 'secret123'\nx = Math.random()\n")
 
             wizard = SecurityLearningWizard(pattern_storage_path=tmpdir)
             result = await wizard.analyze({"project_path": tmpdir})
@@ -437,7 +437,7 @@ class TestSecurityLearningWizardIntegration:
         """Test analysis on secure project."""
         with tempfile.TemporaryDirectory() as tmpdir:
             (Path(tmpdir) / "secure.py").write_text(
-                "import os\n" "secret = os.environ.get('SECRET')\n"
+                "import os\nsecret = os.environ.get('SECRET')\n"
             )
 
             wizard = SecurityLearningWizard(pattern_storage_path=tmpdir)

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_templates.py

@@ -13,12 +13,7 @@ Tests cover:
 from pathlib import Path
 from unittest.mock import MagicMock
 
-from empathy_os.templates import (
-    TEMPLATES,
-    cmd_new,
-    list_templates,
-    scaffold_project,
-)
+from empathy_os.templates import TEMPLATES, cmd_new, list_templates, scaffold_project
 
 
 class TestTemplateDefinitions:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_timeout.py

@@ -10,11 +10,7 @@ from unittest.mock import patch
 
 import pytest
 
-from empathy_os.resilience.timeout import (
-    TimeoutError,
-    timeout,
-    with_timeout,
-)
+from empathy_os.resilience.timeout import TimeoutError, timeout, with_timeout
 
 
 class TestTimeoutError:

{empathy_framework-3.5.5 → empathy_framework-3.5.6}/tests/test_wizard_api.py

@@ -226,7 +226,8 @@ class TestWizardAPIErrorHandling:
     def test_422_wrong_type_for_input(self, client):
         """Test 422 response when input is wrong type."""
         response = client.post(
-            "/api/wizard/test_domain/process", json={"input": 12345}  # Should be string
+            "/api/wizard/test_domain/process",
+            json={"input": 12345},  # Should be string
         )
         assert response.status_code == 422