Kailash Python SDK

Getting Started

  • Installation
    • System Requirements
    • Quick Install
      • Core SDK
      • Frameworks
    • Install from Source
    • Environment Setup
      • Virtual Environment (Recommended)
    • Verify Installation
    • Docker Installation
    • Development Setup
    • Next Steps
  • Quickstart
    • Core SDK – Your First Workflow
    • Kaizen – AI Agent in 3 Lines
    • Nexus – Multi-Channel Platform
    • DataFlow – Zero-Config Database
    • CARE Trust – Context, Action, Reasoning, Evidence
    • Async Runtime for Docker / FastAPI
    • Next Steps
  • Getting Started
    • Prerequisites
    • Core Concepts
    • Building Workflows
      • Adding Nodes
      • Connecting Nodes
    • Executing Workflows
      • LocalRuntime (Sync)
      • AsyncLocalRuntime (Async)
      • Auto-Detection
      • Runtime Configuration
    • CARE Trust Framework
    • Choosing a Framework
    • Common Patterns
      • Data Processing Pipeline
      • AI-Powered Workflow
      • Cyclic Workflow
    • Next Steps

Core SDK

  • Workflows
    • WorkflowBuilder
      • Creating a Workflow
      • Adding Nodes
      • Connecting Nodes
      • Building and Executing
      • Passing Parameters at Execution
    • Parallel Branches
    • Cyclic Workflows
    • Conditional Execution
    • Connection Validation
    • Workflow with Trust
    • Best Practices
  • Nodes
    • Node Basics
    • Node Categories
      • Data Nodes
      • AI / LLM Nodes
      • Logic Nodes
      • Code Nodes
    • Custom Nodes
      • Async Custom Nodes
      • Cycle-Aware Nodes
    • Node Parameters
    • Best Practices
  • Runtime
    • Runtime Selection
    • LocalRuntime
    • AsyncLocalRuntime
    • Architecture
      • BaseRuntime Foundation
      • Shared Mixins
      • LocalRuntime-Specific
    • Configuration
      • Full Configuration Example
      • Validation Metrics
    • Trust Integration
    • Performance Notes
    • Best Practices
  • CARE Trust Framework
    • Why Trust Matters
    • Core Concepts
      • Trust Verification Modes
      • RuntimeTrustContext
      • TrustVerifier
    • Usage Patterns
      • No-Trust Mode (Default)
      • Permissive Mode (Log Only)
      • Enforcing Mode (Block Untrusted)
    • Trust Postures
      • Posture Levels
      • Posture Transitions
      • Constraint Dimensions
    • Knowledge Ledger
    • Framework Integration
      • Kaizen Integration
      • DataFlow Integration
      • Nexus Integration
    • Governance-Required Posture
    • Best Practices
  • MCP Server Integration
    • Overview
    • MCP Server
    • MCP Client Integration
    • Transports
    • Security
    • See Also

Frameworks

  • Kaizen – AI Agent Framework
    • Quick Start
      • Two-Line Agent
      • Autonomous Agent with Memory
    • Core Concepts
      • Unified Agent API
      • Signature-Based Programming
      • BaseAgent Architecture
    • Multi-Agent Coordination
      • OrchestrationRuntime
      • FallbackRouter Safety
    • CARE/EATP Trust
    • MCP Session Methods
    • Key Features Summary
    • Relationship to Core SDK
    • See Also
  • Nexus – Multi-Channel Platform
    • Quick Start
      • Handler Pattern (Recommended)
      • Workflow Registration
    • Core Concepts
      • Unified Sessions
      • Native Middleware API
      • Preset System
    • Authentication and Authorization
      • NexusAuthPlugin
      • Rate Limiting
      • Tenant Isolation
    • CARE Trust Integration
    • Key Features Summary
    • Relationship to Core SDK
    • See Also
  • DataFlow – Database Framework
    • Quick Start
    • Critical Gotchas
    • Database Support
    • Async Transactions
    • Multi-Tenancy
    • Multi-Instance Isolation
    • CARE Trust Integration
    • Key Features Summary
    • Relationship to Core SDK
    • See Also

Guides

  • Migrating from django-celery-beat
    • What it does — and what it can’t
    • Usage
    • Worked example
    • Translation rules
    • Notes

Enterprise

  • Enterprise Features
    • Enterprise Security
      • CARE Trust Foundation
      • NexusAuthPlugin
      • Security Defaults
      • Trust Verification Modes
      • See Also
    • Compliance & Governance
      • CARE-Based Compliance
      • Trust Postures for Governance
      • Data Governance
      • See Also
    • Enterprise Monitoring
      • Workflow Monitoring
      • Validation Metrics
      • Trust Audit Trail
      • Performance Notes
      • See Also
    • Production Deployment
      • Runtime Selection
      • Docker Deployment
      • Nexus Deployment
      • Environment Variables
      • Trust in Production
      • See Also
    • Edge Computing Platform
      • Overview
      • Architecture
      • Core Components
        • EdgeCoordinationNode
        • EdgeDiscoveryNode
        • EdgeStateManagerNode
      • Production Workflows
        • Distributed Rate Limiting
        • Coordinated Deployment
      • Performance Characteristics
      • Best Practices
      • Integration with Applications
      • See Also
    • Overview
    • CARE Trust Integration
    • Getting Started
  • Enterprise Security
    • CARE Trust Foundation
    • NexusAuthPlugin
    • Security Defaults
    • Trust Verification Modes
    • See Also
  • Compliance & Governance
    • CARE-Based Compliance
    • Trust Postures for Governance
    • Data Governance
    • See Also
  • Enterprise Monitoring
    • Workflow Monitoring
    • Validation Metrics
    • Trust Audit Trail
    • Performance Notes
    • See Also
  • Production Deployment
    • Runtime Selection
    • Docker Deployment
    • Nexus Deployment
    • Environment Variables
    • Trust in Production
    • See Also
  • Edge Computing Platform
    • Overview
    • Architecture
    • Core Components
      • EdgeCoordinationNode
      • EdgeDiscoveryNode
      • EdgeStateManagerNode
    • Production Workflows
      • Distributed Rate Limiting
      • Coordinated Deployment
    • Performance Characteristics
    • Best Practices
    • Integration with Applications
    • See Also

Examples & Patterns

  • Examples
    • Basic Examples
      • Simple Data Processing
    • Advanced Examples
      • Complex Workflow with Conditional Logic
    • Integration Examples
      • SharePoint Integration
      • API Integration
    • Workflow Patterns
      • Parallel Processing Pattern
      • Error Handling Pattern
      • State Management Pattern
      • Cyclic Workflow Patterns
        • Retry Pattern with Backoff
        • Iterative Optimization Pattern
        • Data Quality Improvement Pattern
        • Stream Processing Pattern
        • Multi-Node Cycle Pattern
        • Best Practices for Cyclic Workflows
        • Alert and Notification Patterns
    • Example Categories
    • Quick Example

API Reference

  • API Reference
    • Workflow
      • Workflow Class
        • Workflow
      • WorkflowBuilder
        • WorkflowBuilder
      • Workflow Graph Management
      • Cyclic Workflows (Enhanced in v0.2.0)
        • CycleBuilder API (New in v0.2.0)
        • CycleAnalyzer (New in v0.2.0)
        • CycleDebugger (New in v0.2.0)
        • CycleProfiler (New in v0.2.0)
      • WorkflowRunner
        • WorkflowRunner
      • State Management
        • StateManager
        • WorkflowStateWrapper
      • Workflow Patterns
        • Sequential Pipeline
        • Parallel Processing
        • Conditional Routing
        • Error Handling
        • Dynamic Workflows
      • Workflow Visualization
        • MermaidVisualizer
      • Workflow Serialization
        • Export Workflows
        • Import Workflows
      • Best Practices
      • Cycle Configuration (New in v0.2.0)
        • CycleConfig
      • Migration Tools (New in v0.2.0)
        • CyclificationOpportunity
        • CyclificationSuggestion
        • DAGToCycleConverter
      • See Also
    • Runtime
      • Overview
      • Runtime Selection
      • LocalRuntime
        • LocalRuntime
      • AsyncLocalRuntime
        • AsyncLocalRuntime
      • BaseRuntime
        • BaseRuntime
      • Trust Runtime
        • RuntimeTrustContext
        • TrustVerificationMode
        • get_runtime_trust_context()
        • set_runtime_trust_context()
        • runtime_trust_context()
        • VerificationResult
        • TrustVerifierConfig
        • TrustVerifier
        • MockTrustVerifier
        • AuditEventType
        • AuditEvent
        • RuntimeAuditGenerator
      • Durable Execution & Distributed Dispatch (v2.14.0+)
        • NodeCompletionEvent
        • NodeCompletionHookRegistry
        • WorkflowShapeDriftError
        • compute_workflow_fingerprint()
        • build_checkpoint_key()
        • redact_event_for_persistence()
        • redacted_tracker_state_for_checkpoint()
        • encode_checkpoint_payload()
        • decode_checkpoint_payload()
        • check_shape_drift_or_raise()
        • resolve_tenant_id()
        • DurableExecutionEngine
        • DurableExecutionEngineBuilder
        • Dispatcher
        • Task
        • compute_task_id()
      • CyclicWorkflowExecutor
        • CyclicWorkflowExecutor
      • ParallelCyclicRuntime
        • ParallelCyclicRuntime
      • ParallelRuntime
        • ParallelRuntime
      • DockerRuntime
        • DockerRuntime
      • TestingRuntime
      • Runtime Comparison
      • Custom Runtime Development
      • Performance Optimization
        • Local Runtime
        • Async Runtime
        • Parallel Runtime
        • Docker Runtime
      • Error Handling
      • Monitoring and Metrics
      • See Also
    • Nodes
      • Base Node Classes
        • Node
        • AsyncNode
        • CycleAwareNode
      • Data Nodes
        • DirectoryReaderNode (New in v0.2.1)
        • Readers
        • Writers
        • Database Nodes
        • SharePoint Nodes
      • Transform Nodes
        • FilterNode
        • Map
        • Sort
        • DataTransformer (Enhanced in v0.2.1)
        • Text Processing
      • Logic Nodes
        • SwitchNode
        • MergeNode
        • WorkflowNode
        • Validator
      • AI/ML Nodes
      • API Nodes
        • HTTPRequestNode
        • RESTClientNode
        • GraphQLClient
      • MCP Nodes
        • MCPClient
      • Alert Nodes
        • DiscordAlertNode
      • Code Nodes
        • PythonCodeNode (Enhanced in v0.2.1)
      • Custom Node Development
      • Node Configuration Best Practices
      • See Also
    • Workflow API Wrapper
      • Overview
      • Core Components
        • WorkflowAPI Class
        • HierarchicalRAGAPI Class
        • Factory Functions
      • Request/Response Models
        • WorkflowRequest
        • WorkflowResponse
        • ExecutionMode
      • Usage Examples
        • Basic Usage
        • Synchronous Execution
        • Asynchronous Execution
        • Custom Endpoints
      • Production Deployment
        • Development Mode
        • Production Configuration
        • HTTPS Support
        • Docker Deployment
      • Advanced Features
        • Middleware Integration
        • Authentication
        • Rate Limiting
      • Specialized APIs
        • RAG API Example
      • Best Practices
      • See Also
    • Middleware Components
      • Overview
      • Core Components
        • Agent-UI Middleware
        • API Gateway
        • Real-time Middleware
      • Event System
        • Event Stream
        • Event Types
        • Event Filtering
        • Event Classes
      • Authentication & Security
        • JWT Authentication Manager
        • Access Control Manager
      • MCP Integration
        • MCP Server
        • MCP Client
        • MCP Tool Node
        • MCP Resource Node
      • Database Layer
        • Database Manager
        • Workflow Repository
        • Database Models
      • Schema Generation
        • Node Schema Generator
        • Dynamic Schema Registry
      • Usage Patterns
        • Basic Middleware Stack
        • Production Configuration
        • Frontend Integration
      • Migration Guide
        • From Legacy API to Middleware
        • Breaking Changes in v0.4.0
      • Performance Considerations
        • Session Management
        • Real-time Communication
        • Database Performance
      • Testing
        • Unit Testing
        • Integration Testing
      • Related Documentation
    • Access Control
      • Access Control Manager
        • AccessControlManager
      • User Context
        • UserContext
      • Permission Rules
        • PermissionRule
      • Access Decisions
        • AccessDecision
      • Enumerations
        • WorkflowPermission
        • NodePermission
        • PermissionEffect
      • Access Controlled Runtime
        • AccessControlledRuntime
        • AccessControlConfig
        • execute_with_access_control()
      • Base Nodes with ACL
        • NodeWithAccessControl
        • AsyncNodeWithAccessControl
        • make_node_access_controlled()
        • add_access_control()
      • Examples
        • Basic RBAC Setup
        • Multi-Tenant Isolation
        • Data Masking
        • Permission-Based Routing
    • Tracking
      • Overview
      • TaskManager
        • TaskManager
      • Tracking Models
        • WorkflowRun
        • Task
        • TaskMetrics
      • Storage Backends
        • FileSystemStorage
        • DatabaseStorage
        • Custom Storage Backend
      • Tracking Configuration
        • Environment Variables
        • Configuration File
        • Programmatic Configuration
      • Analytics and Reporting
        • Run Analytics
        • Performance Analysis
        • Resource Usage Analysis
        • Custom Reports
      • Real-time Monitoring
        • Live Tracking
        • Event Streaming
        • Webhooks
      • Performance Metrics Collection
        • MetricsCollector
        • PerformanceMetrics
      • Performance Visualization
        • PerformanceVisualizer
      • Best Practices
      • See Also
    • Monitoring & Alerting API
      • ValidationMetrics
        • ValidationMetrics.__init__()
        • ValidationMetrics.record_validation_attempt()
        • ValidationMetrics.get_success_rate()
        • ValidationMetrics.get_cache_hit_rate()
        • ValidationMetrics.clear_metrics()
        • ValidationMetrics.create_metric()
        • ValidationMetrics.get_all_metrics()
        • ValidationMetrics.get_metric()
        • ValidationMetrics.increment()
        • ValidationMetrics.record_histogram()
        • ValidationMetrics.record_timer()
        • ValidationMetrics.set_gauge()
      • SecurityMetrics
        • SecurityMetrics.__init__()
        • SecurityMetrics.record_security_violation()
        • SecurityMetrics.record_blocked_connection()
        • SecurityMetrics.get_violation_rate()
        • SecurityMetrics.get_critical_violations()
        • SecurityMetrics.clear_metrics()
        • SecurityMetrics.create_metric()
        • SecurityMetrics.get_all_metrics()
        • SecurityMetrics.get_metric()
        • SecurityMetrics.increment()
        • SecurityMetrics.record_histogram()
        • SecurityMetrics.record_timer()
        • SecurityMetrics.set_gauge()
      • PerformanceMetrics
        • PerformanceMetrics.__init__()
        • PerformanceMetrics.record_operation()
        • PerformanceMetrics.update_system_metrics()
        • PerformanceMetrics.get_p95_response_time()
        • PerformanceMetrics.clear_metrics()
        • PerformanceMetrics.create_metric()
        • PerformanceMetrics.get_all_metrics()
        • PerformanceMetrics.get_metric()
        • PerformanceMetrics.increment()
        • PerformanceMetrics.record_histogram()
        • PerformanceMetrics.record_timer()
        • PerformanceMetrics.set_gauge()
      • AlertManager
        • AlertManager.__init__()
        • AlertManager.add_rule()
        • AlertManager.remove_rule()
        • AlertManager.add_notification_channel()
        • AlertManager.start()
        • AlertManager.stop()
        • AlertManager.get_active_alerts()
        • AlertManager.get_all_alerts()
        • AlertManager.silence_alert()
        • AlertManager.acknowledge_alert()
      • AlertRule
        • AlertRule.name
        • AlertRule.description
        • AlertRule.severity
        • AlertRule.metric_name
        • AlertRule.condition
        • AlertRule.threshold
        • AlertRule.time_window
        • AlertRule.evaluation_interval
        • AlertRule.notification_interval
        • AlertRule.labels
        • AlertRule.annotations
        • AlertRule.enabled
        • AlertRule.evaluate()
        • AlertRule.__init__()
      • AlertSeverity
        • AlertSeverity.INFO
        • AlertSeverity.WARNING
        • AlertSeverity.ERROR
        • AlertSeverity.CRITICAL
        • AlertSeverity.__contains__()
        • AlertSeverity.__getitem__()
        • AlertSeverity.__iter__()
        • AlertSeverity.__len__()
      • AsyncSQLMetrics
        • AsyncSQLMetrics.__init__()
        • AsyncSQLMetrics.record_lock_acquisition()
        • AsyncSQLMetrics.set_active_locks()
        • AsyncSQLMetrics.record_pool_operation()
        • AsyncSQLMetrics.timed_lock_acquisition()
      • enable_metrics()
      • disable_metrics()
      • get_global_metrics()
      • set_global_metrics()
      • record_lock_acquisition()
      • record_pool_operation()
      • set_active_locks()
      • integrate_with_async_sql()
      • Metrics Collection
        • MetricType
        • MetricSeverity
        • MetricPoint
        • MetricSeries
        • MetricsCollector
        • ValidationMetrics
        • SecurityMetrics
        • PerformanceMetrics
        • MetricsRegistry
        • get_metrics_registry()
        • render_prometheus_exposition()
        • get_validation_metrics()
        • get_security_metrics()
        • get_performance_metrics()
      • Alert Management
        • AlertSeverity
        • AlertStatus
        • Alert
        • AlertRule
        • NotificationChannel
        • LogNotificationChannel
        • EmailNotificationChannel
        • SlackNotificationChannel
        • WebhookNotificationChannel
        • AlertManager
        • create_default_alert_rules()
      • Usage Examples
        • Basic Monitoring Setup
        • Custom Metrics Collection
        • Security Monitoring
        • Performance Monitoring
        • Connection Validation Monitoring
        • Metrics Export
    • Visualization
      • Overview
      • Real-time Dashboard
        • RealTimeDashboard
      • Dashboard Configuration
        • DashboardConfig
      • Live Metrics
        • LiveMetrics
      • Performance Reporter
        • WorkflowPerformanceReporter
      • Report Formats
        • ReportFormat
      • Performance Insights
        • PerformanceInsight
      • Dashboard API
        • SimpleDashboardAPI
      • WebSocket Server
        • DashboardAPIServer
      • Performance Visualizer
        • PerformanceVisualizer
      • Usage Examples
        • Basic Real-time Monitoring
        • Performance Report Generation
        • API-based Monitoring
        • WebSocket Streaming Server
        • Real-time Callbacks
      • Dashboard Features
      • Architecture
      • Best Practices
    • Utils
      • Export Utilities
        • WorkflowExporter
        • Export Formats
        • Export Options
      • Hierarchical RAG Utilities
        • RAG Components
      • Node Registry Utilities
        • NodeRegistry
        • Registering Custom Nodes
        • Node Discovery
      • Configuration Utilities
        • ConfigValidator
        • ConfigMerger
        • Environment Resolution
      • Visualization Utilities
        • WorkflowVisualizer
        • Execution Timeline
      • Performance Utilities
        • Profiling
        • Benchmarking
        • Optimization Suggestions
      • Testing Utilities
        • WorkflowTester
        • MockNode
        • TestDataGenerator
      • See Also
    • CLI
      • Overview
      • Installation
      • Basic Usage
        • Run a Workflow
        • Workflow File Format
      • CLI Commands
        • kailash run
        • kailash list
        • kailash info
        • kailash validate
        • kailash export
        • kailash visualize
        • kailash test
        • kailash profile
        • kailash debug
        • kailash server
      • Configuration
        • CLI Configuration File
        • Environment Variables
      • Extending the CLI
        • Custom Commands
        • CLI Scripting
        • Python API Integration
      • Best Practices
      • See Also
    • Core SDK
      • Workflow
      • Runtime
      • Trust
      • Nodes
    • Frameworks
      • Kaizen (v1.2.1)
      • Nexus (v1.4.1)
      • DataFlow (v0.12.1)
    • Import Quick Reference

Development

  • Contributing
    • Getting Started
    • Development Workflow
    • Code Style Guidelines
    • Testing Guidelines
    • Documentation
    • Pull Request Process
    • Community Guidelines
    • Getting Help
  • Testing Infrastructure
    • Overview
    • Key Achievements
    • Test Architecture
    • Performance Breakthrough
    • Docker Integration
    • Test Categories
    • Performance Monitoring
    • Test Fixtures
    • Running Tests
    • Test Configuration
    • Continuous Integration
    • Best Practices
    • Troubleshooting
    • Legacy and Migration
    • Future Enhancements
    • Summary
    • See Also
  • Best Practices
    • Node Development
      • Creating Custom Nodes
      • Data Handling
    • Workflow Design
      • Workflow Patterns
    • Error Handling
      • Node-Level Error Handling
      • Workflow-Level Error Handling
    • Testing Strategies
      • Unit Testing Nodes
      • Integration Testing Workflows
    • Performance Optimization
      • Memory Management
      • Parallel Execution
      • Caching Strategies
    • Monitoring and Logging
      • Performance Monitoring
      • Structured Logging
    • Security Considerations
      • Input Sanitization
      • Configuration Validation
    • Cyclic Workflow Best Practices
      • Designing Cyclic Workflows
      • Cycle Safety Guidelines
      • Performance Optimization for Cycles
      • Common Pitfalls to Avoid
  • License
Kailash Python SDK
  • Python Module Index

Python Module Index

k
 
k
- kailash
    kailash.monitoring
    kailash.monitoring.alerts
    kailash.monitoring.metrics
    kailash.nodes.base_with_acl
    kailash.runtime.access_controlled
    kailash.runtime.dispatcher
    kailash.runtime.durable
    kailash.runtime.trust
    kailash.workflow.migration

© Copyright 2026, Terrene Foundation.

Built with Sphinx using a theme provided by Read the Docs.