Skip to content

v0.1.0

Choose a tag to compare

@github-actions github-actions released this 12 Apr 14:22
· 355 commits to v0.x.x since this release
v0.1.0
0281586

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

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