v0.12.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Update repo-config and setuptools versions
• Timestamps in the response are now timezone aware.

New Features

• Support for streaming: By omitting the end date in the request,
  the client will return any historical data from timestamp until now and
  keep streaming new data as it arrives.
• Also the start date can be omitted which let's the data start at the
  earliest time stamp that is available.

Bug Fixes

What's Changed

• Update notes after release by @flora-hofmann-frequenz in #115
• Support for streaming by @cwasicki in #116
• Update repo-config and setuptools by @flora-hofmann-frequenz in #117
• Bump the required group across 1 directory with 5 updates by @dependabot in #122
• Bump the artifacts group with 2 updates by @dependabot in #121
• Ensure tz-aware timestamps in response by @cwasicki in #124
• Update version no in readme by @flora-hofmann-frequenz in #125
• Bump the required group with 6 updates by @dependabot in #127
• Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by @dependabot in #128

Full Changelog: v0.11.0...v0.12.0

v0.11.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

This update comes with a breaking change, that originates from a breaking change in the API specs. Specifically:

• This and later versions of the client can only be used with the latest reporting API service >=v0.7 but not with older versions of the service.
• Older versions of the client can only be used with the reporting API service versions < v0.7 but no later versions.
  To ensure compatibility, both the client and service must be updated simultaneously.

New Features

Bug Fixes

What's Changed

• Fix readme by @cwasicki in #112
• Change release notes after release by @flora-hofmann-frequenz in #113
• Upgrade to reporting API v0.5 by @flora-hofmann-frequenz in #114

Full Changelog: v0.10.0...v0.11.0

v0.10.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Enforce keyword arguments in 'run' function of 'main' module
• Change 'resolution' 'int' to 'resampling_period' 'timedelta'

New Features

• The CLI tool supports requesting component states without metrics.

Bug Fixes

What's Changed

• Update README w.r.t states and bounds by @cwasicki in #101
• Add keyword requirement by @flora-hofmann-frequenz in #104
• Bump the required group across 1 directory with 18 updates by @dependabot in #103
• Bump the required group with 7 updates by @dependabot in #106
• Support requesting no metrics in CLI tools by @cwasicki in #109
• Update base client to v0.8.0 by @cwasicki in #111
• Change resolution to resample_period by @flora-hofmann-frequenz in #105

Full Changelog: v0.9.0...v0.10.0

v0.9.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Update and fix readme to make use of newest release version 0.8.0
• Updates the base client to version 0.6.

New Features

• States can now be requested via the client and are provided through the flat iterator.
  They can be identified via their category state, warning and error, respectively.
  Each individual state is provided as its own sample.

• Bounds can now be requested via the client and are provided through the flat iterator.
  They can be identified via their category metric_bound[i]_{upper,lower}.
  Each individual bound is provided as its own sample.

• Support for states and bound is also added to the CLI tool via the --states and --bounds flag, respectively.

Bug Fixes

What's Changed

• Update release notes after release by @flora-hofmann-frequenz in #94
• Update readme to version 0.8.0 by @flora-hofmann-frequenz in #95
• Fix typo in readme server url by @flora-hofmann-frequenz in #96
• Add support for states in client and cli tool by @cwasicki in #97
• Add support for bounds in client by @cwasicki in #98
• Update base client dependency to v0.6 by @cwasicki in #99

Full Changelog: v0.8.0...v0.9.0

v0.8.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

• Integration of the base client v0.5

Bug Fixes

What's Changed

• Release notes update after release v0.7.0 by @flora-hofmann-frequenz in #82
• Update readme to v0.7.0 by @flora-hofmann-frequenz in #83
• Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by @dependabot in #84
• Bump flake8 from 6.1.0 to 7.1.0 by @dependabot in #87
• Bump docker/build-push-action from 5 to 6 by @dependabot in #85
• Integrate BaseClient into reporting client by @flora-hofmann-frequenz in #89

Full Changelog: v0.7.0...v0.8.0

v0.7.0

Frequenz Reporting API Client Release Notes

New Features

• TLS is now enabled for all connections.

What's Changed

• Clear release notes by @cwasicki in #72
• Update client version in readme by @cwasicki in #73
• Remove page_size from readme by @flora-hofmann-frequenz in #74
• Fix/ensure secure connection by @flora-hofmann-frequenz in #76
• Include resampling in readme by @flora-hofmann-frequenz in #78
• Add new service address to readme by @flora-hofmann-frequenz in #80
• Update release notes before release by @flora-hofmann-frequenz in #81

Full Changelog: v0.6.0...v0.7.0

v0.6.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• The client now uses the streaming endpoint for historical data requests. The page size parameter is no longer required.

New Features

Bug Fixes

What's Changed

• Clear release notes by @cwasicki in #70
• Update README with reporting-cli usage instructions by @cwasicki in #71
• Use streaming endpoint in list_microgrid_components_data by @cwasicki in #67

Full Changelog: v0.5.0...v0.6.0

v0.5.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Install command line tool as reporting-cli: The command line tool from the example is moved
  to the package and can be called via reporting-cli or python -m frequenz.client.reporting
  from the command line.
• The command-line argument --display is renamed to --format for reporting-cli.
• The reporting-cli tool can output CSV format, dataframe output is removed.

New Features

Bug Fixes

What's Changed

• Update README for API key usage by @cwasicki in #64
• Minor: Remove verbose prints from example client by @cwasicki in #65
• Minor: Change default page size in client example by @cwasicki in #66
• Clear release notes by @cwasicki in #68
• Bump types-protobuf from 4.24.0.20240129 to 5.26.0.20240422 by @dependabot in #61
• Install example command line tool as reporting-cli by @cwasicki in #69

Full Changelog: v0.4.0...v0.5.0

v0.4.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Upgrading "frequenz-api-reporting >= 0.1.1, < 0.2" to "frequenz-api-reporting >= 0.2.0, < 0.3"
• Upgrading "frequenz-client-common == 0.1.0" to "frequenz-client-common >= 0.2.0, < 0.3"

New Features

• An API key for authorization can now be passed to the ReportingApiClient.

Bug Fixes

What's Changed

• Update release notes after release by @flora-hofmann-frequenz in #55
• Document resampling README by @flora-hofmann-frequenz in #57
• Update reporting api dependency by @flora-hofmann-frequenz in #58
• Update protobuf requirement from <5,>=4.25.3 to >=4.25.3,<6 by @dependabot in #62
• Bump the required group with 16 updates by @dependabot in #60
• Support authorization via API key by @cwasicki in #63

Full Changelog: v0.3.0...v0.4.0

v0.3.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

• The ReportingApiClient exposes the resampling option of the data, with its
  resolution represented in second and its default set to None.

• Updated README with usage instructions.

Bug Fixes

What's Changed

• clear release notes after v0.2.0 release by @mhrrmk in #48
• Bump black from 23.9.1 to 24.4.2 by @dependabot in #50
• Bump nox from 2023.4.22 to 2024.4.15 by @dependabot in #51
• Expose resampling option by @flora-hofmann-frequenz in #52
• Update README with usage instructions by @cwasicki in #53
• Update release notes before release by @flora-hofmann-frequenz in #54

New Contributors

• @dependabot made their first contribution in #50

Full Changelog: v0.2.0...v0.3.0