Prepared report templates

[Flix6x]

Description

Part of the "Reports as automations" story of #2288: hosts can now discover and use prepared report templates — ready-made report definitions (reporter class + complete config + parameters skeleton) — instead of authoring reporter YAML from scratch.

What's included

Packaged templates (flexmeasures/data/templates/reports/, shipped in the wheel):

• energy-costs (ProfitOrLossReporter): energy costs over the reporting window, from a power/energy sensor and a consumption price sensor (costs reported as positive values, via loss_is_positive).
• self-consumption (PandasReporter): share of produced energy consumed on-site, from a production and a consumption sensor (elementwise min(production, consumption) averaged per reporting period, divided by average production).

Each template contains name, description, reporter, a complete config, and a parameters skeleton with FILL_IN sensor placeholders, plus a recommended rolling reporting window (start-offset: -1D,DB / end-offset: DB) for recurring use.

CLI:

• flexmeasures show report-templates lists the templates (name, reporter, description); --name <name> prints the full commented YAML, ready to pipe to a file.
• flexmeasures add report --template <name> and flexmeasures add automation --type reports --template <name> load the template's reporter/config/parameters as defaults. User input wins: an explicit --reporter is kept, top-level keys of --config/--parameters files override the template's, and user-provided timing fields (start/end/offsets, in the parameters or as CLI options) replace the template's recommended window as a group.
• Placeholders left unfilled abort with a clear validation error listing the exact fields to fill in.
• Offset fields (start-offset/end-offset) inside a parameters file now also work for flexmeasures add report (as fallbacks for the CLI options), matching how report automations store their rolling window.

Tests (flexmeasures/cli/tests/test_report_templates.py, 5 tests):

• Both templates' configs and (filled-in) parameter skeletons load cleanly against their reporter's schemas.
• show report-templates lists both templates and prints valid YAML per template.
• add automation --type reports --template self-consumption with a parameters file that fills the sensors creates a working automation: running it queues a reporting job, and a worker computes and stores the expected daily self-consumption shares.
• Unfilled placeholders, unknown templates and --template on non-report automations produce clear errors.

Docs: new "Report templates" section in documentation/features/reporting.rst, CLI changelog bullets, and a show report-templates row in the commands overview.

Packaging note: verified that the YAML templates are included in the built wheel (hatchling ships all files under the flexmeasures package); no MANIFEST/package-data changes needed.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Rbix8k1JfeUWNXEmHEZVpX

[read-the-docs-community]

Documentation build overview

📚 flexmeasures | 🛠️ Build #33546366 | 📁 Comparing 5e6c48d against latest (4a5892f)

  🔍 Preview build  

35 files changed · + 6 added · ± 29 modified

+ Added

• _autosummary/flexmeasures.data.models.automations.html
• _autosummary/flexmeasures.data.schemas.automations.html
• _autosummary/flexmeasures.data.services.automations.html
• _autosummary/flexmeasures.data.services.report_templates.html
• _autosummary/flexmeasures.data.services.reporting.html
• features/automations.html

± Modified

• changelog.html
• genindex.html
• http-routingtable.html
• index.html
• py-modindex.html
• _autosummary/flexmeasures.api.v3_0.assets.html
• _autosummary/flexmeasures.cli.utils.html
• _autosummary/flexmeasures.data.models.data_sources.html
• _autosummary/flexmeasures.data.models.html
• _autosummary/flexmeasures.data.models.reporting.html
• and 19 more...