Skip to content

docs: Clarify Quick Start: fitness_functions.yaml vs config.py #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tjirab wants to merge 2 commits into from
Closed

docs: Clarify Quick Start: fitness_functions.yaml vs config.py #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1144573
Clarify that fitness settings live in fitness_functions.yaml.
tjirab Jun 24, 2026
ce3d98d
Merge branch 'main' into docs/clarify-quick-start-config
tjirab Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ uv add ../sqlmesh-ff

## Quick start

1. Add `fitness_functions.yaml` to your SQLMesh project root (see [Configuration](#configuration)).
2. Add a small `config.py` bootstrap (see [Where configuration lives](#where-configuration-lives)) — SQLMesh requires the loader as a Python class and cannot load `config.py` and `config.yaml` in the same folder.
Your fitness function settings live in **`fitness_functions.yaml`** — that is the config you edit. The project `config.py` is optional SQLMesh wiring only (see below).

1. Add `fitness_functions.yaml` to your SQLMesh project root with your thresholds and rule toggles (see [Configuration](#configuration)).
2. **Optional — only for native SQLMesh commands** (`sqlmesh plan`, etc.): add a small `config.py` bootstrap that registers `FitnessLoader` and points at `fitness_functions.yaml` (see [Where configuration lives](#where-configuration-lives)). SQLMesh requires the loader as a Python class and cannot load `config.py` and `config.yaml` in the same folder. You do **not** put fitness settings in `config.py`.
3. Run lint:

```bash
Expand Down
Loading