Frequenz-client-reporting

Frequenz Reporting API Client Release Notes

Summary

<!-- Here goes a general summary of what this release is about -->

Upgrading

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

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

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.

<!-- Here goes the main new features and examples or instructions on how to use them -->

Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->


What's Changed
* Clear release notes after release by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/133
* Support requests for multiple components and formulas via CLI tool by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/134
* Bump the required group with 5 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/135
* Bump black from 24.10.0 to 25.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/137
* Bump isort from 5.13.2 to 6.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/136
* Ensure timezone-aware timestamps in formula endpoint result by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/138


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-reporting-python/compare/v0.13.0...v0.13.1

Frequenz Reporting API Client Release Notes

Summary

<!-- Here goes a general summary of what this release is about -->

Upgrading


New Features

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

Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->


What's Changed
* Update frequenz-client-common requirement from <0.3,>=0.2.0 to >=0.2.0,<0.4 by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/129
* Update version in README by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/130
* Add method to receive aggregated data by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/131
* Change common dependency to v0.3.0 by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/132


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-reporting-python/compare/v0.12.0...v0.13.0

Frequenz Reporting API Client Release Notes

Summary

<!-- Here goes a general summary of what this release is about -->

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

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->


What's Changed
* Update notes after release by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/115
* Support for streaming by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/116
* Update repo-config and setuptools by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/117
* Bump the required group across 1 directory with 5 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/122
* Bump the artifacts group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/121
* Ensure tz-aware timestamps in response by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/124
* Update version no in readme by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/125
* Bump the required group with 6 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/127
* Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/128


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-reporting-python/compare/v0.11.0...v0.12.0

Frequenz Reporting API Client Release Notes

Summary

<!-- Here goes a general summary of what this release is about -->

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

<!-- Here goes the main new features and examples or instructions on how to use them -->

Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->


What's Changed
* Fix readme by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/112
* Change release notes after release by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/113
* Upgrade to reporting API v0.5 by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/114


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-reporting-python/compare/v0.10.0...v0.11.0

Frequenz Reporting API Client Release Notes

Summary

<!-- Here goes a general summary of what this release is about -->

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

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->


What's Changed
* Update README w.r.t states and bounds by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/101
* Add keyword requirement by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/104
* Bump the required group across 1 directory with 18 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/103
* Bump the required group with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/106
* Support requesting no metrics in CLI tools by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/109
* Update base client to v0.8.0 by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/111
* Change resolution to resample_period by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/105


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-reporting-python/compare/v0.9.0...v0.10.0

Frequenz Reporting API Client Release Notes

Summary

<!-- Here goes a general summary of what this release is about -->

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

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->


What's Changed
* Update release notes after release by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/94
* Update readme to version 0.8.0 by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/95
* Fix typo in readme server url by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/96
* Add support for states in client and cli tool by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/97
* Add support for bounds in client by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/98
* Update base client dependency to v0.6 by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/99


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-reporting-python/compare/v0.8.0...v0.9.0