v0.8.4

Frequenz Dispatch Client Library Release Notes

Bug Fixes

• Fix missing dependency in last release.
• The FakeClient.set_dispatches() method now correctly updates FakeService._last_id which is used to generate unique dispatch IDs.
• Fix that streams were globally shared between all clients.

What's Changed

• Bump types-python-dateutil from 2.9.0.20241003 to 2.9.0.20241206 by @dependabot in #121
• Update frequenz-client-common requirement from <0.3.0,>=0.1.0 to >=0.1.0,<0.4.0 by @dependabot in #122
• Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by @dependabot in #120
• Bump the required group across 1 directory with 7 updates by @dependabot in #123
• Fix some problems that related to flakey tests by @Marenz in #124

Full Changelog: v0.8.3...v0.8.4

v0.8.3

Frequenz Dispatch Client Library Release Notes

Bug Fixes

• Fix missing dependency in last release

What's Changed

• Fix missing dependency by @Marenz in #118

Full Changelog: v0.8.2...v0.8.3

v0.8.2

Frequenz Dispatch Client Library Release Notes

Summary

• The dispatch-cli application now features fancy colors and formatting!

Bug Fixes

• Fixed a bug where the dispatch-cli application would crash when reading a Dispatch with frequency YEARLY

What's Changed

• Add colors and formatting to dispatch-cli by @Marenz in #110
• Bump setuptools-scm[toml] from 7.1.0 to 8.1.0 by @dependabot in #112
• Bump setuptools from 68.1.0 to 75.6.0 by @dependabot in #113
• Apply new repo-config 0.11 templates by @llucax in #115
• Bump the required group across 1 directory with 8 updates by @dependabot in #114
• Add missing YEARLY mapping for recurrence by @Marenz in #116

Full Changelog: v0.8.1...v0.8.2

v0.8.1

Frequenz Dispatch Client Library Release Notes

Summary

• The base client dependency was updated to v0.8.0.

What's Changed

• Fix base-client used wrongly by @Marenz in #108
• Use new BaseClient version by @Marenz in #109

Full Changelog: v0.8.0...v0.8.1

v0.8.0

Frequenz Dispatch Client Library Release Notes

New Features

• Update BaseApiClient to get the http2 keepalive feature.
• Some Methods from the high-level API have been moved to this repo: The dispatch class now offers: until, started, next_run and next_run_after.
• Add start_immediately support to the create method. You can now specify "NOW" as the start time to trigger immediate dispatch. Note: While the dispatch CLI previously allowed this by converting "NOW" to a timestamp client-side before sending it to the server, this functionality is now supported directly on the server side!

What's Changed

• Enhance readme, add links, reformat by @Marenz in #100
• Bump the required group with 8 updates by @dependabot in #101
• Update BaseClient to support keepalive by @Marenz in #104
• Move some high-level functions to this repo by @Marenz in #103
• Update API and add support for start_immediately by @Marenz in #105
• Update readme for release by @Marenz in #106

Full Changelog: v0.7.1...v0.8.0

v0.7.1

Frequenz Dispatch Client Library Release Notes

Bug Fixes

• Fix crash by adding the missing YEARLY frequency.

What's Changed

• Include init files in sybil by @Marenz in #96
• Bump the required group across 1 directory with 19 updates by @dependabot in #95
• Add YEARLY frequency by @Marenz in #97

Full Changelog: v0.7.0...v0.7.1

v0.7.0

Frequenz Dispatch Client Library Release Notes

Upgrading

• Client.stream() will now raise an Exception when the connection is lost.

New Features

• Added support for duration=None when creating a dispatch.
• The FakeService now supports the stream() method.

What's Changed

• Add support for duration=None by @Marenz in #85
• Fix duration in cli.create by @Marenz in #86
• Implement stream() for FakeService by @Marenz in #87
• Client.stream: Raise exception on connection loss by @Marenz in #94

Full Changelog: v0.6.0...v0.7.0

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

v0.5.0

Frequenz Dispatch Client Library Release Notes

Summary

The client was updated to the latest API version and supports most of its features.

Upgrading

• All commands now require the microgrid_id parameter.
• The selector can now also be a list of component categories.

New Features

• Added a new option to allow insecure connections, can be set using the flag "--insecure" or the environment variable FREQUENZ_INSECURE (default is false).
• The update command now returns the modified dispatch.
• We use our own root CA certificate to verify the server's certificate until we have a proper certificate chain.

What's Changed

• Reset release notes by @Marenz in #59
• Small enhancements by @Marenz in #60
• Add parameter to use insecure connections by @Marenz in #63
• Bump the required group with 10 updates by @dependabot in #64
• Bump docker/build-push-action from 5 to 6 by @dependabot in #65
• Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by @dependabot in #66
• Update to latest API changes by @Marenz in #67
• Ship our own root certificate until we have a proper one by @Marenz in #68
• Update dispatch API by @Marenz in #69
• Update to dispatch API v0.15.0 by @Marenz in #70

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

v0.4.0

Frequenz Dispatch Client Library Release Notes

Upgrading

• An API key for authorization must now be passed to the DispatchClient.
• The client constructor now requires named parameters. If you are using the client directly, you will need to update your code to use named parameters.

New Features

• TLS is now enabled by default for the CLI client.

What's Changed

• Fix broken CI fix that prevented release by @Marenz in #55
• Reset releasenotes by @Marenz in #54
• Implement key-based authentication by @Marenz in #56
• Prepare for release by @Marenz in #58

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