Skip to content

Lingo Docs

Lingo is a workflow orchestration toolkit for running the same Python task graph in local development and distributed worker deployments.

This documentation is designed for two audiences:

  • Humans who need to understand system behavior, setup, and operations.
  • AI coding assistants that need precise, machine-readable context to generate correct changes.

Start Here

  • New users: read Getting Started first.
  • System design questions: read Architecture and Core Concepts.
  • Runtime behavior and deployment: read Execution Modes, Retries and Recovery, and CLI Guide.
  • Integration flow: read FastAPI Example.
  • Testing strategy: read Testing Guide.
  • Assistant-oriented contribution rules: read AI Assistant Guide.

What This Repository Contains

  • lingo/: Core package, runtime primitives, and integrations.
  • lingo/celery/: Celery runtime, envelope metadata, serialization protocol.
  • lingo/storage/: Corpus helpers and Mongo-based journal.
  • lingo/bucket/: S3-compatible artifact archive implementation.
  • examples/fastapi/: End-to-end API integration with worker modules.
  • tests/: Behavioral and regression test coverage for orchestration semantics.

Documentation Model

This site combines:

  • Guide pages for architecture, operations, and practices.
  • Auto-generated API reference from Python docstrings using mkdocstrings.

Docstring rendering is configured for Google style, which is required for new public APIs.