API ReferenceΒΆ

Complete API documentation for all kstlib modules. Each page documents public classes, functions, and configuration options with type signatures and usage examples.


alerts

AlertManager, channels (Slack, Email), throttling.

Alerts Subsystem
auth

OAuth2Client, TokenStorage, PKCE, providers.

Authentication
cache

@cached, CacheStrategy, memory/file backends.

Cache Utilities
cli

app (Typer root), subcommand groups, verbose flags.

CLI
config

load_config(), ConfigLoader, presets, includes.

Configuration Loader
db

AsyncDatabase, ConnectionPool, SQLCipher.

Database
helpers

TimeTrigger, time-based scheduling utilities.

Helpers
logging

LogManager, setup_logging(), TRACE level.

Logging Manager
mail

MailBuilder, transports (SMTP, Gmail, Resend).

Mail Subsystem
metrics

@metrics, @call_stats, Stopwatch.

Metrics Utilities
monitoring

StatusCell, MetricCell, Jinja2 renderer.

Monitoring API
ops

SessionManager, TmuxRunner, ContainerRunner.

Session Management (Ops)
pipeline

PipelineRunner, StepConfig, ShellStep, PythonStep.

Pipeline
rapi

RapiClient, call(), HMAC signing, credentials.

REST API Client
resilience

CircuitBreaker, Heartbeat, Watchdog, RateLimiter.

Resilience Utilities
secrets

SecretResolver, SOPS, KMS, keyring providers.

Secrets
secure

PathGuardrails path validation + Argon2id password hashing.

Secure
transform

TransformChain, primitives (base64, zlib, json, xml), composed patches.

Bidirectional Data Transformation
ui

Panel, Table, Spinner for Rich terminal output.

UI Helpers
utils

Formatting, validators, LazyModule, helpers.

Utilities
websocket

WebSocketManager, reconnection, proactive control.

WebSocket Subsystem

Exception Catalog

Complete catalog of all exceptions by module with mitigation guides.

Exception Catalog

Tip

For narrative guides with practical examples, see Features.