FastFlowTransform Documentation Hub

Welcome! This page is your starting point for FastFlowTransform docs. Pick the track that matches what you want to do and follow the links to the detailed guides.

---

Docs Navigation

• Getting Started — you are here (docs/index.md)
• User Guide
• Modeling Reference
• Parallelism & Cache
• API calls in Python models
• Incremental Models
• YAML Tests (Schema-bound)
• Data Quality Tests Reference
• Profiles & Environments
• Sources Declaration
• Project Configuration
• State Selection (changed & results)
• Basic Demo Overview
• Cross-Table Reconciliations
• Auto-Docs & Lineage
• Developer Guide

Table of Contents

• Docs Navigation
• Choose Your Path
• Reference Map
• Need Help?

---

Choose Your Path

1. Build & Operate Projects (Data Practitioners)

• Get set up quickly: follow the dedicated Quickstart guide for installation, seeding, and a first run.
• Need local runtimes? The API demo local engine setup walks through DuckDB, Postgres, and Databricks Spark.
• Understand the project layout & CLI workflow: see Project Layout, Makefile Targets, and CLI Flows in the Technical Overview.
• Configure runtimes & profiles: review executor profiles, environment overrides, and logging options in the Technical Overview.
• Model data quality & troubleshoot runs: the Technical Overview covers unit tests, troubleshooting tips, and exit codes.
• Explore runnable demos: start with the Basic Demo Overview or browse the examples/ directory; each subproject ships with its own README.

2. Extend FastFlowTransform (Developers & Contributors)

• Dive into architecture & core modules: start with Architecture Overview and Core Modules for registry, DAG, executors, validation, and more.
• Add tests & seeds: see Sample Models, Seeds & Example Data, and the unit test guide in Model Unit Tests.
• Contribute code: follow the workflow described in ./Contributing.md and consult the module-level docs for internal APIs.
• Plan ahead: check the roadmap snapshot in the Technical Overview to understand upcoming work.

---

Reference Map

• Modeling reference — Jinja configuration, macros, helper functions: Config_and_Macros.md
• CLI entry point & commands — src/fastflowtransform/cli.py
• Registry & node loading — src/fastflowtransform/core.py
• Unit test runner — src/fastflowtransform/utest.py
• Rendered DAG templates — src/fastflowtransform/docs/templates/

---

Need Help?

• Open an issue or PR — see ./Contributing.md for guidelines.
• Join the discussion (planning doc / roadmap highlights) — see the roadmap section in the Technical Overview.
• If you spot gaps in the docs, file an issue with the context and links to the relevant section.