v0.3.7

Frequenz Client Common Library Release Notes

Summary

This release main change is the introduction of a new metrics package compatible with the common API v0.8 (v1alpha8) (the old metric package, in singular, still works with the old v0.5/v1 version).

Deprecations

• The old frequenz.client.common.enum_proto module is now deprecated, please use frequenz.client.common.proto.enum_from_proto instead.

New Features

• New frequenz.client.common.common.proto module with conversion utilities for protobuf types:
  • enum_from_proto() (moved from `enum_proto).
  • datetime_to_proto() and datetime_from_proto() functions to convert between Python datetime and protobuf Timestamp (imported from frequenz-client-base.
• New metrics package compatible with API v0.8, which includes:
  • Metric enum with all supported metrics.
  • MetricSample dataclass to represent metric samples.
  • AggregatedMetricValue dataclass to represent derived statistical summaries.
  • Bounds dataclass to represent bounds for metrics.
  • MetricConnection and MetricConnectionCategory to represent connections from which metrics are obtained.
  • proto submodule with conversion functions to/from protobuf types.

What's Changed

• Build(deps): Bump pydoclint from 0.6.6 to 0.6.11 by @dependabot[bot] in #111
• Build(deps): Bump mkdocstrings-python from 1.16.12 to 1.18.2 in the mkdocstrings group by @dependabot[bot] in #107
• Build(deps): Bump actions/download-artifact from 4 to 5 in the artifacts group by @dependabot[bot] in #108
• Build(deps): Bump setuptools-scm[toml] from 8.3.1 to 9.2.0 by @dependabot[bot] in #109
• Build(deps): Bump types-markdown from 3.8.0.20250708 to 3.8.0.20250809 by @dependabot[bot] in #110
• Build(deps): Bump the patch group with 3 updates by @dependabot[bot] in #106
• Build(deps): Bump actions/checkout from 4 to 5 by @dependabot[bot] in #105
• Build(deps): Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #112
• Build(deps): Bump the patch group with 3 updates by @dependabot[bot] in #113
• Build(deps): Bump pytest-asyncio from 1.1.0 to 1.2.0 by @dependabot[bot] in #115
• Build(deps): Bump pydoclint from 0.6.11 to 0.7.3 by @dependabot[bot] in #116
• Build(deps): Bump the minor group across 1 directory with 7 updates by @dependabot[bot] in #117
• Build(deps-dev): Bump pydoclint from 0.7.3 to 0.7.6 by @dependabot[bot] in #125
• Build(deps-dev): Bump nox from 2025.5.1 to 2025.10.16 in the minor group by @dependabot[bot] in #122
• Build(deps-dev): Bump the patch group across 1 directory with 3 updates by @dependabot[bot] in #127
• Migrate to frequenz-floss dependabot-auto-approve action by @Marenz in #126
• Add Dependabot auto-merge workflow by @Marenz in #118
• Build(deps-dev): Bump pylint from 3.3.8 to 4.0.2 by @dependabot[bot] in #124
• Add metrics package compatible with v1alpha8 by @llucax in #128

Full Changelog: v0.3.6...v0.3.7