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

v0.14.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Updates 'FilterOption' in client to be able to use reporting-api version 0.7.0

New Features

Bug Fixes

What's Changed

• Clear release notes after release by @flora-hofmann-frequenz in #139
• Bump nox from 2024.10.9 to 2025.2.9 by @dependabot in #143
• Bump types-protobuf from 5.29.1.20241207 to 5.29.1.20250208 by @dependabot in #142
• Update frequenz-client-base requirement from <0.9.0,>=0.8.0 to >=0.8.0,<0.10.0 by @dependabot in #145
• Update repo config w migration script by @flora-hofmann-frequenz in #148
• Bump the required group across 1 directory with 9 updates by @dependabot in #149
• Update client to use FilterOptions by @flora-hofmann-frequenz in #150
• Take grpcio-tools out of dependencies by @flora-hofmann-frequenz in #152

Full Changelog: v0.13.1...v0.14.0

v0.13.1

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• The CLI tool is moved to dedicated folder.
• Timestamps of aggregated (formula) requests are now timezone-aware.

New Features

• Support data requests for multiple component IDs from command line.
• Support for passing formula strings as a cid argument from the command line.

Bug Fixes

What's Changed

• Clear release notes after release by @flora-hofmann-frequenz in #133
• Support requests for multiple components and formulas via CLI tool by @cwasicki in #134
• Bump the required group with 5 updates by @dependabot in #135
• Bump black from 24.10.0 to 25.1.0 by @dependabot in #137
• Bump isort from 5.13.2 to 6.0.0 by @dependabot in #136
• Ensure timezone-aware timestamps in formula endpoint result by @cwasicki in #138

Full Changelog: v0.13.0...v0.13.1

v0.13.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

• Adds new method receive_aggregated_data to receive microgrid component data
  aggregated by user-defined formulae.

Bug Fixes

What's Changed

• Update frequenz-client-common requirement from <0.3,>=0.2.0 to >=0.2.0,<0.4 by @dependabot in #129
• Update version in README by @cwasicki in #130
• Add method to receive aggregated data by @cwasicki in #131
• Change common dependency to v0.3.0 by @flora-hofmann-frequenz in #132

Full Changelog: v0.12.0...v0.13.0