v0.20.2

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

Bug Fixes

• Remove invalid HasField check on scalar which can cause failure retrieving formula-aggregated metrics.

What's Changed

• Remove invalid HasField check on proto3 scalar metric value by @cwasicki in #254

Full Changelog: v0.20.1...v0.20.2

v0.20.1

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

Bug Fixes

• Fix default value of formula-aggregated metrics when no data was sent.

What's Changed

• Bump actions/checkout from 5 to 6 by @dependabot[bot] in #243
• Bump frequenz-floss/dependabot-auto-approve from v1.3.0 to v1.3.2 by @dependabot[bot] in #244
• Bump pydoclint from 0.7.6 to 0.8.3 by @dependabot[bot] in #250
• Bump the patch group with 4 updates by @dependabot[bot] in #245
• Bump mkdocstrings[python] from 0.30.1 to 1.0.0 by @dependabot[bot] in #248
• Bump pytest from 8.4.2 to 9.0.1 by @dependabot[bot] in #251
• Fix aggregated values for missing data by @cwasicki in #253
• Bump types-protobuf from 6.32.1.20250918 to 6.32.1.20251105 by @dependabot[bot] in #247
• Bump the minor group with 7 updates by @dependabot[bot] in #246
• Bump frequenz-floss/gh-action-nox from 1.0.1 to 1.1.0 in the compatible group by @dependabot[bot] in #242

Full Changelog: v0.20.0...v0.20.1

v0.20.0

Frequenz Reporting API Client Release Notes

Summary

Warning: This client is compatible only with Reporting API v1alpha10 or later.
Using with services that use an older API version will cause failures.

Upgrading

• Breaking change to reporting API v1alpha10.
• Switch to new metrics package from client-common.

New Features

Bug Fixes

What's Changed

• Update release notes after release by @flora-hofmann-frequenz in #207
• Improve README by @cwasicki in #208
• Update link to metric docs in README by @cwasicki in #209
• Bump mypy from 1.16.1 to 1.17.1 in the minor group by @dependabot[bot] in #212
• Bump the compatible group with 2 updates by @dependabot[bot] in #210
• Bump mkdocstrings[python] from 0.29.1 to 0.30.0 in the mkdocstrings group by @dependabot[bot] in #213
• Bump pytest-asyncio from 1.0.0 to 1.1.0 by @dependabot[bot] in #217
• Bump types-protobuf from 6.30.2.20250516 to 6.30.2.20250703 by @dependabot[bot] in #214
• Bump mkdocs-material from 9.6.14 to 9.6.16 in the patch group by @dependabot[bot] in #211
• Bump types-markdown from 3.8.0.20250415 to 3.8.0.20250708 by @dependabot[bot] in #215
• Bump async-solipsism from 0.7 to 0.8 by @dependabot[bot] in #216
• Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #223
• Bump actions/download-artifact from 4 to 5 by @dependabot[bot] in #222
• Bump actions/checkout from 4 to 5 by @dependabot[bot] in #221
• Bump the patch group with 4 updates by @dependabot[bot] in #224
• Bump pydoclint from 0.6.6 to 0.7.3 by @dependabot[bot] in #226
• Bump mkdocstrings-python from 1.16.12 to 1.18.2 by @dependabot[bot] in #229
• Bump setuptools-scm[toml] from 8.3.1 to 9.2.0 by @dependabot[bot] in #228
• Bump the minor group with 7 updates by @dependabot[bot] in #225
• Add Dependabot Auto Manage workflow by @Marenz in #230
• Bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #232
• Bump the patch group with 5 updates by @dependabot[bot] in #233
• Bump pydoclint from 0.7.3 to 0.7.6 by @dependabot[bot] in #238
• Bump actions/download-artifact from 5 to 6 by @dependabot[bot] in #231
• Bump nox from 2025.5.1 to 2025.10.16 in the minor group by @dependabot[bot] in #234
• Bump pylint from 3.3.8 to 4.0.2 by @dependabot[bot] in #236
• Migrate to frequenz-floss dependabot-auto-approve action by @Marenz in #239
• Bump isort from 6.0.1 to 7.0.0 by @dependabot[bot] in #235
• Update to reporting API v1alpha10 by @cwasicki in #240
• Bump pytest-asyncio from 1.1.0 to 1.2.0 by @dependabot[bot] in #227
• Minor: Fix missing release notes entry by @cwasicki in #241

New Contributors

• @Marenz made their first contribution in #230

Full Changelog: v0.19.0...v0.20.0

v0.19.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Update to frequenz-api-reporting v0.8.0

New Features

• Expose aggregated metrics if available.

Bug Fixes

• Update example in README to use receive_single_component_data.

What's Changed

• Fix README by @matthias-wende-frequenz in #197
• Fix README by @cwasicki in #198
• Bump the patch group with 6 updates by @dependabot in #199
• Bump pytest-asyncio from 0.26.0 to 1.0.0 by @dependabot in #200
• Bump flake8 from 7.2.0 to 7.3.0 in the minor group by @dependabot in #202
• Expose aggregated metrics by @flora-hofmann-frequenz in #204
• Renaming to allow for api-reporting update by @flora-hofmann-frequenz in #205
• Fix sampled_at for metrics by @flora-hofmann-frequenz in #206

New Contributors

• @matthias-wende-frequenz made their first contribution in #197

Full Changelog: v0.18.1...v0.19.0

v0.18.1

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

Bug Fixes

What's Changed

• Update version number in README by @cwasicki in #194
• Update README by @cwasicki in #195
• Clear release notes after release by @florian-wagner-frequenz in #193

Full Changelog: v0.18.0...v0.18.1

v0.18.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• The key parameter of the client has been renamed to auth_key

New Features

• Add HMAC generation capabilities.
  • The new CLI option "sign_secret" can be used to provide the server's HMAC secret.
  • The client itself now has a "sign_secret" argument in the constructor.
  • Update documentation describing how to use the above options.

Bug Fixes

What's Changed

• Update release notes and readme after release by @flora-hofmann-frequenz in #191
• Add HMAC capabilities by @florian-wagner-frequenz in #181
• Update Readme for HMAC by @florian-wagner-frequenz in #192

New Contributors

• @florian-wagner-frequenz made their first contribution in #181

Full Changelog: v0.17.1...v0.18.0

v0.17.1

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• The receive_aggregated_data method now returns a Receiver, which provides more flexibility that the previous AsyncIterator.
• The receive_microgrid_sensors_data, receive_single_sensor_data and receive_aggregated_data methods are no-longer async.

New Features

Bug Fixes

What's Changed

• Update release notes after release by @flora-hofmann-frequenz in #188
• Take out async for sensors by @flora-hofmann-frequenz in #189
• Reuse GrpcStreamBroadcasters for aggregated data streams by @shsms in #190

New Contributors

• @shsms made their first contribution in #190

Full Changelog: v0.17.0...v0.17.1

v0.17.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Change 'start_dt' and 'end_dt' to 'start_time' and 'end_time' respectively.
• Rename 'list' to 'receive' in component data retrival functions
• Return the receiver directly in '_recieve_microgrid_components_data_batch'

New Features

Bug Fixes

What's Changed

• Update release notes after release by @flora-hofmann-frequenz in #170
• Bump the minor group with 3 updates by @dependabot in #172
• Bump grpc-stubs from 1.53.0.5 to 1.53.0.6 by @dependabot in #173
• Bump pydoclint from 0.6.5 to 0.6.6 by @dependabot in #174
• Bump setuptools from 78.1.0 to 80.1.0 by @dependabot in #175
• Add sensor request to readme by @flora-hofmann-frequenz in #176
• Bump the patch group with 3 updates by @dependabot in #171
• Change timestamp naming by @flora-hofmann-frequenz in #178
• Update mkdocs by @flora-hofmann-frequenz in #180
• Update README by @flora-hofmann-frequenz in #179
• Bump the patch group with 6 updates by @dependabot in #182
• Update components retrival functions by @flora-hofmann-frequenz in #177
• Bump types-protobuf from 5.29.1.20250403 to 6.30.2.20250516 by @dependabot in #184
• Bump the minor group across 1 directory with 4 updates by @dependabot in #186
• Update proto warnings by @flora-hofmann-frequenz in #187
• Update frequenz-client-base requirement from <0.10.0,>=0.8.0 to >=0.8.0,<0.11.0 by @dependabot in #185

Full Changelog: v0.16.0...v0.17.0

v0.16.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

• Add sensor endpoint to client.

Bug Fixes

What's Changed

• Update release notes by @flora-hofmann-frequenz in #162
• Update repo config to v0.13.0 by @flora-hofmann-frequenz in #163
• Update protobuf requirement from <6,>=5.29.3 to >=5.29.3,<7 by @dependabot in #157
• Bump the patch group with 7 updates by @dependabot in #164
• Bump pydoclint from 0.6.2 to 0.6.5 by @dependabot in #168
• Bump pytest-asyncio from 0.25.3 to 0.26.0 by @dependabot in #166
• Bump types-protobuf from 5.29.1.20250315 to 5.29.1.20250403 by @dependabot in #167
• Bump flake8 from 7.1.2 to 7.2.0 in the minor group by @dependabot in #165
• Add sensor ID by @flora-hofmann-frequenz in #169

Full Changelog: v0.15.0...v0.16.0

v0.15.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

• Introduced 'GrpcStreamBroadcaster' from the base client to enable keep-alive options for gRPC streaming.
• The 'ChannelOptions' are currently set to the base client default, but can be change as an input.

Bug Fixes

What's Changed

• Update release notes after release by @flora-hofmann-frequenz in #153
• Introduce GrpcStreamBroadcaster to enable keep_alive options by @flora-hofmann-frequenz in #154
• Bump setuptools from 75.8.0 to 78.1.0 by @dependabot in #158
• Bump types-protobuf from 5.29.1.20250208 to 5.29.1.20250315 by @dependabot in #159
• Bump types-markdown from 3.7.0.20241204 to 3.7.0.20250322 by @dependabot in #160

Full Changelog: v0.14.0...v0.15.0