v0.3.6

Frequenz Client Common Library Release Notes

Summary

This is the same release as v0.3.5 but with prefixes in Event enum values removed. The v0.3.5 release will be yanked from PyPI and it should not be used.

Upgrading

• The pagination.Params class is deprecated; use the protobuf message directly.
• The pagination.Info class is deprecated in favor of the new pagination.PaginationInfo class.

New Features

• Mapping for the new Event message has been added.

• Add new common API enums for ElectricalComponent (previously Components).

• Added v1alpha8 variants of the pagination data structures.

Bug Fixes

• Updated display of protobuf version warnings

What's Changed

• Remove prefixes from Event enum values by @llucax in #104

Full Changelog: v0.3.5...v0.3.6

v0.3.5

Frequenz Client Common Library Release Notes

Summary

Upgrading

• The pagination.Params class is deprecated; use the protobuf message directly.
• The pagination.Info class is deprecated in favor of the new pagination.PaginationInfo class.

New Features

• Mapping for the new Event message has been added.

• Add new common API enums for ElectricalComponent (previously Components).

• Added v1alpha8 variants of the pagination data structures.

Bug Fixes

• Updated display of protobuf version warnings

What's Changed

• Fix v0.x.x by @llucax in #102
• Add v1alpha8 variant of pagination structs by @Marenz in #103

Full Changelog: v0.3.4...v0.3.5

v0.3.4

Frequenz Client Common Library Release Notes

Summary

This release introduces the v1alpha8 module to support a new API version.

Upgrading

New Features

• Provide access to new API using new v1alpha8 module.
• Mapping for the new Event message has been added.

Bug Fixes

• Updated display of protobuf version warnings

What's Changed

• Rename Components to ElectricalComponents by @flora-hofmann-frequenz in #71
• Add conftest to allow for wider range of Protobuf version exceptions by @flora-hofmann-frequenz in #72
• Build(deps): Bump the patch group with 6 updates by @dependabot[bot] in #75
• Build(deps): Bump the minor group with 2 updates by @dependabot[bot] in #76
• Update display of protobuf version warnings by @flora-hofmann-frequenz in #74
• Clear release notes by @llucax in #83
• Build(deps): Bump pytest-asyncio from 0.26.0 to 1.0.0 by @dependabot[bot] in #88
• Build(deps): Bump the patch group with 6 updates by @dependabot[bot] in #86
• Build(deps): Bump the minor group with 2 updates by @dependabot[bot] in #87
• Build(deps): Bump pytest-asyncio from 1.0.0 to 1.1.0 by @dependabot[bot] in #93
• Build(deps): Bump mypy from 1.16.1 to 1.17.1 in the minor group by @dependabot[bot] in #91
• Build(deps): Bump types-markdown from 3.8.0.20250415 to 3.8.0.20250708 by @dependabot[bot] in #94
• Build(deps): Bump async-solipsism from 0.7 to 0.8 by @dependabot[bot] in #95
• Build(deps): Bump mkdocs-material from 9.6.15 to 9.6.16 in the patch group by @dependabot[bot] in #90
• Build(deps): Bump mkdocstrings[python] from 0.29.1 to 0.30.0 in the mkdocstrings group by @dependabot[bot] in #92
• feat: Update frequenz-api-common to v0.8 and adapt to API changes by @Marenz in #96
• Merge v0.3.x into v0.x.x by @Marenz in #97
• Add streaming.Event bindings by @Marenz in #99
• Apply changes from v0.3 to v1alpha8 by @Marenz in #98
• Build(deps): Bump the compatible group with 2 updates by @dependabot[bot] in #89

Full Changelog: v0.3.3...v0.3.4

v0.3.3

Frequenz Client Common Library Release Notes

Summary

Upgrading

• The metrics and components enums .from_proto() are deprecated, please use the new enum_from_proto() instead.

• Some minimum dependencies have been bumped, you might need to update your minimum dependencies too:

  • frequenz-api-common to 0.6.1
  • frequenz-core to 1.0.2

New Features

• A new module frequenz.client.common.enum_proto has been added, which provides a generic enum_from_proto() function to convert protobuf enums to Python enums.
• The frequenz.client.common.microgrid.ComponentCategory was extended to include the missing categories.

Bug Fixes

What's Changed

• Clear release notes by @llucax in #80
• Improve enums and add a generic enum_from_proto() by @llucax in #82

Full Changelog: v0.3.2...v0.3.3

v0.3.2

Frequenz Client Common Library Release Notes

Summary

This release replaces the failed v0.3.1 release.

Upgrading

• The typing-extensions dependency minimum version was bumped to 4.13 to support Python 3.12.

New Features

• New BaseId class to create unique IDs for entities in the system.

• New ID classes for microgrid-related entities:

  • EnterpriseId
  • MicrogridId
  • ComponentId
  • SensorId

What's Changed

• Clear release notes by @llucax in #78
• Fix dependencies and prepare release notes for v0.3.2 release by @llucax in #79

Full Changelog: v0.3.1...v0.3.2

v0.3.0

Frequenz Client Common Library Release Notes

Summary

Update of the Pagination Params data class.

Upgrading

• Pagination Params has been changed such that the page_size and page_token fields are now no longer optional.

New Features

• Additional information for energy metric.
• Add component state codes.
• Add component error codes.

Bug Fixes

What's Changed

• Reset release notes after release by @flora-hofmann-frequenz in #34
• Bump the required group with 8 updates by @dependabot in #35
• Bump docker/build-push-action from 5 to 6 by @dependabot in #37
• Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by @dependabot in #38
• Bump the required group with 7 updates by @dependabot in #36
• Bump the required group with 9 updates by @dependabot in #40
• Update metric info by @flora-hofmann-frequenz in #39
• Bump the required group with 11 updates by @dependabot in #41
• Bump the required group with 7 updates by @dependabot in #42
• Page size and token no longer optional in pagination Params by @cyiallou in #45
• Add component states and error codes by @cyiallou in #44
• Bump the required group across 1 directory with 9 updates by @dependabot in #46
• Apply new repo-config 0.11 templates by @llucax in #47
• Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by @dependabot in #51
• Bump setuptools-scm[toml] from 7.1.0 to 8.1.0 by @dependabot in #50
• Bump the required group with 2 updates by @dependabot in #48
• Bump setuptools from 68.1.0 to 75.6.0 by @dependabot in #49

New Contributors

• @cyiallou made their first contribution in #45

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

v0.2.0

Frequenz Client Common Library Release Notes

Upgrading

• Upgrading metric __init__ to names from api-common release v0.6.0

What's Changed

• Clean up release notes by @cwasicki in #23
• Bump nox from 2023.4.22 to 2024.3.2 by @dependabot in #25
• Bump the optional group with 9 updates by @dependabot in #24
• Bump the optional group with 2 updates by @dependabot in #27
• Bump the required group with 6 updates by @dependabot in #28
• Don't recursively scan for pyproject.toml when calculating the cache key by @flora-hofmann-frequenz in #32
• Update metric names by @flora-hofmann-frequenz in #30
• Update dependencies in line with api-common release by @flora-hofmann-frequenz in #31
• Update release notes before release by @flora-hofmann-frequenz in #33

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

v0.1.0

Frequenz Client Common Library Release Notes

Summary

This is the initial release of the Frequenz Client Common Library.
It provides wrappers around the types from Frequenz's common API protobuf definitions.
This version contains types to support pagination in gRPC requests
and enum types for components and metrics to be used in a microgrid.

Upgrading

New Features

Bug Fixes

What's Changed

• Bump actions/cache from 3 to 4 by @dependabot in #9
• Bump the optional group with 13 updates by @dependabot in #10
• Add new labels to configuration files by @llucax in #12
• Bump actions/labeler from 4.3.0 to 5.0.0 by @dependabot in #2
• Fix newly added labeler config for new version by @Marenz in #13
• Bump actions/{download,upload}-artifact from 3 to 4 by @dependabot in #7
• Add component types by @Marenz in #11
• Add pagination types by @flora-hofmann-frequenz in #15
• Bump actions/setup-python from 4 to 5 by @dependabot in #1
• Bump black from 23.9.1 to 24.2.0 by @dependabot in #18
• Bump flake8 from 6.1.0 to 7.0.0 by @dependabot in #19
• Bump the optional group with 7 updates by @dependabot in #16
• Bump pytest from 7.4.2 to 8.1.0 by @dependabot in #20
• Add common metric to test with reporting client mvp by @flora-hofmann-frequenz in #21
• Prepare release notes by @cwasicki in #22

New Contributors

• @dependabot made their first contribution in #9
• @llucax made their first contribution in #12
• @Marenz made their first contribution in #13
• @flora-hofmann-frequenz made their first contribution in #15
• @cwasicki made their first contribution in #22

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