Frequenz-client-reporting

Frequenz Reporting API Client Release Notes

Summary

Upgrading

* The `ReportingClient` is renamed to `ReportingApiClient`.

* The client method `iterate_single_component` is renamed to `list_single_component_data`.

New Features

* The client method `list_microgrid_components_data` is added to
expose the functionality of supporting arbitrary lists of microgrid-component IDs
and metric IDs. It is intended to be as close as possible on the gRPC function call.

Bug Fixes



What's Changed
* Clear release notes by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/38
* Make ComponentsDataPage an iterator by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/36
* Update doc for MetricSample by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/35
* Rename ReportingClient to ReportingApiClient by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/29
* Remove iterator from function names by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/33
* Add support for multiple components and microgrids by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/39
* Pin minor version of api dependency to v0.1 by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/44
* Rename client method to list_microgrid_components_data by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/46
* Address todos from the cookiecutter by mhrrmk in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/43

New Contributors
* flora-hofmann-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/39
* mhrrmk made their first contribution in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/43

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

Frequenz Reporting API Client Release Notes

Summary

This release introduces the initial version of the Reporting API client with support for
retrieving historical metrics data for a single component.

Upgrading

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

New Features

* Introducing the initial version of the Reporting API client, streamlined for
retrieving historical metrics data for a single component. It incorporates
pagination handling and utilizes a wrapper data class that retains the raw
protobuf response while offering transformation capabilities limited here
to generators of structured data representation via named tuples.

* Current limitations include a single component focus with plans for extensibility,
ongoing development for states and bounds integration, as well as support for
service-side features like resampling, streaming, and formula aggregations.

* Code examples are provided to guide users through the basic usage of the client.
The example client is a simple command-line tool that retrieves historical metrics
data for a single component and prints it to the console.


Bug Fixes

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


What's Changed
* chore: generate project using repo-config by sandovalrr in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/14
* Introduce simple reporting client with support for single metric historical data by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/16
* Use frequenz-client-common v0.1.0 by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/18
* Add support for requesting multiple metrics by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/26
* Fix return type for next_page_token method by cwasicki in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/28

New Contributors
* sandovalrr made their first contribution in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/14
* cwasicki made their first contribution in https://github.com/frequenz-floss/frequenz-client-reporting-python/pull/16

**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-reporting-python/commits/v0.1.0