v0.2.0

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 #38
• Make ComponentsDataPage an iterator by @cwasicki in #36
• Update doc for MetricSample by @cwasicki in #35
• Rename ReportingClient to ReportingApiClient by @cwasicki in #29
• Remove iterator from function names by @cwasicki in #33
• Add support for multiple components and microgrids by @flora-hofmann-frequenz in #39
• Pin minor version of api dependency to v0.1 by @cwasicki in #44
• Rename client method to list_microgrid_components_data by @cwasicki in #46
• Address todos from the cookiecutter by @mhrrmk in #43

New Contributors

• @flora-hofmann-frequenz made their first contribution in #39
• @mhrrmk made their first contribution in #43

Full Changelog: v0.1.0...v0.2.0

v0.1.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

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

What's Changed

• chore: generate project using repo-config by @sandovalrr in #14
• Introduce simple reporting client with support for single metric historical data by @cwasicki in #16
• Use frequenz-client-common v0.1.0 by @cwasicki in #18
• Add support for requesting multiple metrics by @cwasicki in #26
• Fix return type for next_page_token method by @cwasicki in #28

New Contributors

• @sandovalrr made their first contribution in #14
• @cwasicki made their first contribution in #16

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