Frequenz-client-base

Frequenz Client Base Library Release Notes

Summary

<!-- Here goes a general summary of what this release is about -->

Upgrading

- You should now install the dependency using `frequenz-client-base[grpcio]` (or `frequenz-client-base[grpclib]`) if you want to migrate to `grpclib`).
- `GrpcStreamBroadcaster`'s `stream_method` callback now should return an `AsyncIterator` instead of a `grpc.aio.UnaryStreamCall`, this is so it is compatible with both `grpcio` and `grpclib`. Normally no changes should be needed, as a `grpc.aio.UnaryStreamCall` should be a `AsyncIterator`, but since `grpcio` doesn't have correct type hints, you might need to adjust the `cast()` if you are using one.

New Features

- `GrpcStreamBroadcaster` is now compatible with both `grpcio` and `grpclib` implementations of gRPC. Just install `frequenz-client-base[grpcio]` or `frequenz-client-base[grpclib]` to use the desired implementation and everything should work as expected.
- A new module `channel` with a function to parse URIs to create `grpclib` client `Channel` instances.

Bug Fixes

- Fixed retrying for `GrpcStreamBroadcaster` when the retry interval is set to 0 (before it would stop retrying if the interval was set to 0).


What's Changed
* Clear RELEASE_NOTES.md by shsms in https://github.com/frequenz-floss/frequenz-client-base-python/pull/36
* Bump types-protobuf from 4.24.0.20240129 to 4.24.0.20240311 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/39
* Bump nox from 2023.4.22 to 2024.3.2 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/38
* Update protobuf requirement from <5,>=4.21.6 to >=4.21.6,<6 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/40
* Bump the optional group with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/43
* Bump the required group with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/44
* Bump types-protobuf from 4.24.0.20240311 to 5.26.0.20240422 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/45
* Remove TODOs by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/46
* Bump repo-config to v0.9.2 by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/47
* Fix the condition to run the `nox-(cross-arch-)?all` jobs by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/48
* ci: Fix pip cache post step by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/50
* Make `GrpcStreamBroadcaster` compatible with both `grpcio` and `grpclib` by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/49
* Fix `GrpcStreamBroadcaster` retry with a 0 interval by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/52
* Add parsing of gRPC channel URIs by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/51


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-base-python/compare/v0.3.0...v0.4.0

Frequenz Client Base Library Release Notes

Summary

This release updates the minimum required `frequenz-channels` version is updated
to v1.0.0-rc1. This is a breaking change, because the channels API has changed.

Upgrading

Follow the upgrading instructions from the new channel release: [v1.0.0-rc1](https://github.com/frequenz-floss/frequenz-channels-python/releases/tag/v1.0.0-rc.1).


What's Changed
* Don't create nox sessions twice in cross-arch tests by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/34
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/33
* Update minimum `frequenz-channels` version to `v1.0.0-rc1` by shsms in https://github.com/frequenz-floss/frequenz-client-base-python/pull/35


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-base-python/compare/v0.2.1...v0.3.0

Frequenz Client Base Library Release Notes

Summary

* The generated docs now show the type of symbol in the table of contents and have cross-linking to the protobuf and channels documentation.
* The minimum supported version of `protobuf` was downgraded to 4.21.6, so downstream projects having this older version as minimum requirements can still use this release.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/28
* Bump the optional group with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/29
* Downgrade minimum `protobuf` to 4.21.6 by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/30
* Improve generated docs by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/31
* Prepare release notes for v0.2.1 by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/32


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-base-python/compare/v0.2.0...v0.2.1

Frequenz Client Base Library Release Notes

Summary

This release does a bit of restructuring and renaming of classes and modules. It also adds some new features and fixes some bugs.

Upgrading

The project structure was updated to use more consistent and shorter modules and class names.

* `frequenz.client.base.grpc_streaming_helper` was renamed to `frequenz.client.base.streaming`.

- The `GrpcStreamingHelper` class was renamed to `GrpcStreamBroadcaster`.

+ The constructor argument `retry_spec` was renamed to `retry_strategy`.

* `frequenz.client.base.retry_strategy` was renamed to `frequenz.client.base.retry`.

- The `RetryStrategy` class was renamed to `Strategy`.

New Features

* Functions to convert to `datetime` and protobufs `Timestamp` have been added.
* The generated documentation was improved to include information on defaults and generic parameters.

Bug Fixes

* When copying `RetryStrategy`s, the type now will be correctly set to the original type.


What's Changed
* Clear RELEASE_NOTES.md by shsms in https://github.com/frequenz-floss/frequenz-client-base-python/pull/7
* Bump the optional group with 16 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/8
* Bump actions/cache from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/17
* Bump the optional group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/12
* Bump types-markdown from 3.5.0.3 to 3.5.0.20240129 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/14
* Bump flake8 from 6.1.0 to 7.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/16
* Bump black from 23.12.1 to 24.1.1 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/13
* Bump actions/setup-python from 4 to 5 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/2
* Update to channels v1.0.0-beta.1 by Marenz in https://github.com/frequenz-floss/frequenz-client-base-python/pull/18
* Bump actions/{download,upload}-artifact from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/10
* Fix typo Freqenz -> Frequenz by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/21
* docs: Add cross-referencing for gRPC by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/22
* Add datetime and Timestamp conversion functions by Marenz in https://github.com/frequenz-floss/frequenz-client-base-python/pull/20
* Bump actions/labeler from 4.3.0 to 5.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-base-python/pull/1
* Improve docs and fix `copy()` type by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/23
* Restructure modules and class names by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/25
* Prepare release notes for v0.2.0 by llucax in https://github.com/frequenz-floss/frequenz-client-base-python/pull/27

New Contributors
* dependabot made their first contribution in https://github.com/frequenz-floss/frequenz-client-base-python/pull/8
* Marenz made their first contribution in https://github.com/frequenz-floss/frequenz-client-base-python/pull/18
* llucax made their first contribution in https://github.com/frequenz-floss/frequenz-client-base-python/pull/21

**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-base-python/compare/v0.1.0...v0.2.0

Freqenz Client Base Library Release Notes

Summary

First release of the Freqenz Client Base Library, that exposes a retry strategy implementations and a generic grpc streaming helper.

Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

New Features

- Imports retry strategies and the generic grpc streaming helper from the SDK.

Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->


What's Changed
* Add a grpc streaming helper by shsms in https://github.com/frequenz-floss/frequenz-client-base-python/pull/4
* Release preparation by shsms in https://github.com/frequenz-floss/frequenz-client-base-python/pull/6

New Contributors
* shsms made their first contribution in https://github.com/frequenz-floss/frequenz-client-base-python/pull/4

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