v0.5.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Install command line tool as reporting-cli: The command line tool from the example is moved
  to the package and can be called via reporting-cli or python -m frequenz.client.reporting
  from the command line.
• The command-line argument --display is renamed to --format for reporting-cli.
• The reporting-cli tool can output CSV format, dataframe output is removed.

New Features

Bug Fixes

What's Changed

• Update README for API key usage by @cwasicki in #64
• Minor: Remove verbose prints from example client by @cwasicki in #65
• Minor: Change default page size in client example by @cwasicki in #66
• Clear release notes by @cwasicki in #68
• Bump types-protobuf from 4.24.0.20240129 to 5.26.0.20240422 by @dependabot in #61
• Install example command line tool as reporting-cli by @cwasicki in #69

Full Changelog: v0.4.0...v0.5.0

v0.4.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

• Upgrading "frequenz-api-reporting >= 0.1.1, < 0.2" to "frequenz-api-reporting >= 0.2.0, < 0.3"
• Upgrading "frequenz-client-common == 0.1.0" to "frequenz-client-common >= 0.2.0, < 0.3"

New Features

• An API key for authorization can now be passed to the ReportingApiClient.

Bug Fixes

What's Changed

• Update release notes after release by @flora-hofmann-frequenz in #55
• Document resampling README by @flora-hofmann-frequenz in #57
• Update reporting api dependency by @flora-hofmann-frequenz in #58
• Update protobuf requirement from <5,>=4.25.3 to >=4.25.3,<6 by @dependabot in #62
• Bump the required group with 16 updates by @dependabot in #60
• Support authorization via API key by @cwasicki in #63

Full Changelog: v0.3.0...v0.4.0

v0.3.0

Frequenz Reporting API Client Release Notes

Summary

Upgrading

New Features

• The ReportingApiClient exposes the resampling option of the data, with its
  resolution represented in second and its default set to None.

• Updated README with usage instructions.

Bug Fixes

What's Changed

• clear release notes after v0.2.0 release by @mhrrmk in #48
• Bump black from 23.9.1 to 24.4.2 by @dependabot in #50
• Bump nox from 2023.4.22 to 2024.4.15 by @dependabot in #51
• Expose resampling option by @flora-hofmann-frequenz in #52
• Update README with usage instructions by @cwasicki in #53
• Update release notes before release by @flora-hofmann-frequenz in #54

New Contributors

• @dependabot made their first contribution in #50

Full Changelog: v0.2.0...v0.3.0

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