How-To Guides¶

Practical guides for PyStator: architecture, persistence, workers, discovery, and observability.

Core¶

Architecture

Design goals, sandwich pattern, and how components fit together.

Read Guide
Package structure

Core vs optional extras ([api], [worker], [ui], [all], [dev]).

Read Guide
EntitySession

Per-entity stateful wrapper: send(), snapshots, auto-generated helpers.

Read Guide
Declarative features

YAML check: fields, effects (set, timestamp, …), and StateMachineBuilder.

Read Guide

Schedulers

Delayed transitions: asyncio, Redis, Celery.

Read Guide
State stores

In-memory, PostgreSQL, Redis, MongoDB, custom StateStore adapters.

Read Guide
Configuration

pystator.cfg, environment variables, database URL resolution.

Read Guide
Deployment

Docker, Kubernetes, scaling replicas, default ports.

Read Guide
Worker

pystator worker, submit_event, worker_events queue.

Read Guide
DLQ migration

Dead-letter queue configuration and migration notes.

Read Guide

Linting

Static FSM warnings with pystator.lint.lint().

Read Guide
Hooks and metrics

TransitionObserver, hooks, metrics collectors.

Read Guide
Context and sinks

TransitionContext, event/metric sinks.

Read Guide
Visualization

Mermaid, DOT, SCXML export and statistics.

Read Guide

Discovery (inferred FSM)

Inference engine, candidates, shadow mode, stores.

Read Guide
Classification

Infer state from data, StateClassifier, ingestion.

Read Guide