User Guide

Release:

None.0.13.1

Date:

Aug 04, 2026

• The App - Define your Faust project
  • What is an Application?
  • Application Parameters
  • App Instantation and Configuration
  • Actions
  • Application Signals
  • Starting the App
  • Client-Only Mode
  • Projects and Directory Layout
  • Miscellaneous
  • Reference
• Agents - Self-organizing Stream Processors
  • What is an Agent?
  • Defining Agents
  • Using Agents
• Streams - Infinite Data Structures
  • Basics
  • Processors
  • Message Life Cycle
  • Combining streams
  • Operations
  • Reference
• Channels & Topics - Data Sources
  • Basics
  • Channels
  • Topics
• Models, Serialization, and Codecs
  • Basics
  • In use
  • Schemas
  • Manual Serialization
  • Model Types
  • Fields
  • Codecs
• Tables and Windowing
  • Tables
  • Windowing
• Tasks, Timers, Cron Jobs, Web Views, and CLI Commands
  • Tasks
  • Timers
  • Cron Jobs
  • Web Views
  • HTTP Verbs: GET/POST/PUT/DELETE
  • CLI Commands
• Command-line Interface
  • Program: faust
• Sensors - Monitors and Statistics
  • Basics
  • Monitor
  • Sensor API Reference
• Testing
  • Basics
  • Testing with https://pypi.org/project/pytest/
  • Setting up a test suite
  • Testing agents that don’t yield
  • Testing and windowed tables
• LiveCheck: End-to-end test for production/staging.
  • Tutorial
• Configuration Reference
  • Required Settings
  • Commonly Used Settings
  • Advanced Agent Settings
  • Advanced Broker Settings
  • Advanced Consumer Settings
  • Serialization Settings
  • Advanced Producer Settings
  • Advanced Stream Settings
  • Agent RPC Settings
  • Advanced Table Settings
  • Topic Settings
  • Advanced Web Server Settings
  • Advanced Worker Settings
  • Extension Settings
• Installation
  • Installation
• Kafka - The basics you need to know
  • What you must know about Apache Kafka to use Faust
• Debugging
  • Debugging with https://pypi.org/project/aiomonitor/
• Workers Guide
  • Managing individual instances
  • Managing a cluster