harp.config.example

Generate a commented, source-introspected example config.yml.

The example lists every setting of every default application with its default value, fully commented out, so a freshly scaffolded project ships a self-documenting configuration reference that stays in sync with the actual Pydantic settings models.

iter_app_settings(builder=None)

Yield (app_name, default_settings) for each default application that defines settings.

app_name is the top-level configuration key (the application’s short name); applications without a settings model (e.g. janitor) are skipped.

Parameters:

builder (ConfigurationBuilder | None)

render_example_config(builder=None)

Render a fully-commented reference config.yml for all default applications.

Parameters:

builder (ConfigurationBuilder | None)

Return type:

str