v0.6.0

Frequenz Dispatch Client Library Release Notes

Summary

This release includes a new feature for pagination support in the dispatch list request as well as usage of the base-client for setting up the channel and client configuration.

Upgrading

• The Client.list() function now yields a list[Dispatch] representing one page of dispatches
• Client.__init__ no longer accepts a grpc_channel argument, instead a server_url argument is required.
• For the dispatch-cli client, DISPATCH_API_PORT and DISPATCH_API_HOST environment variables have been replaced with DISPATCH_API_URL which should be a full URL including the protocol (e.g. grpc://fz-0004.frequenz.io:50051)

New Features

• Pagination support in the dispatch list request.
• Client.__init__:
  • Has a new parameter connect which is a boolean that determines if the client should connect to the server on initialization.
  • Automatically sets up the channel for encrypted TLS communication.
• A new method stream() to receive dispatch events in real-time.

What's Changed

• Fix: Update default HOST to FQDN instead of IP by @Marenz in #71
• Implement Pagination for the python client by @Marenz in #74
• Initial work to use base client by @Marenz in #73
• Simplify test code using fixtures by @Marenz in #75
• Configure the new labels by @llucax in #80
• Replace *_HOST and *_PORT env variables with *_URL variable by @Marenz in #78
• Fix labeler configuration by @llucax in #82
• Fix bug where recurrence is not properly unset when not specified by @Marenz in #81
• Implement streaming by @Marenz in #84

Full Changelog: v0.5.0...v0.6.0