Frequenz-client-reporting

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 'resample_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

Frequenz Reporting API Client Release Notes

Summary

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

Upgrading

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

New Features

* Integration of the base client v0.5

Bug Fixes

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


What's Changed
* Release notes update after release v0.7.0 by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/82
* Update readme to v0.7.0 by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/83
* Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/84
* Bump flake8 from 6.1.0 to 7.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/87
* Bump docker/build-push-action from 5 to 6 by dependabot in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/85
* Integrate BaseClient into reporting client by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/89


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-reporting-python/compare/v0.7.0...v0.8.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 https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/72
* Update client version in readme by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/73
* Remove page_size from readme by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/74
* Fix/ensure secure connection by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/76
* Include resampling in readme by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/78
* Add new service address to readme by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/80
* Update release notes before release by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/81


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

Frequenz Reporting API Client Release Notes

Summary

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

Upgrading

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

New Features

Bug Fixes

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


What's Changed
* Clear release notes by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/70
* Update README with reporting-cli usage instructions by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/71
* Use streaming endpoint in list_microgrid_components_data by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/67


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