Frequenz-client-dispatch

Frequenz Dispatch Client Library Release Notes

Summary

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

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.

Bug Fixes

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


What's Changed
* Add support for duration=None by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/85
* Fix duration in cli.create by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/86
* Implement stream() for FakeService by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/87
* Client.stream: Raise exception on connection loss by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/94


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-dispatch-python/compare/v0.6.0...v0.7.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 https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/71
* Implement Pagination for the python client by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/74
* Initial work to use base client by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/73
* Simplify test code using fixtures by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/75
* Configure the new labels by llucax in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/80
* Replace *_HOST and *_PORT env variables with *_URL variable by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/78
* Fix labeler configuration by llucax in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/82
* Fix bug where recurrence is not properly unset when not specified by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/81
* Implement streaming by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/84


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-dispatch-python/compare/v0.5.0...v0.6.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 https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/59
* Small enhancements by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/60
* Add parameter to use insecure connections by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/63
* Bump the required group with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/64
* Bump docker/build-push-action from 5 to 6 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/65
* Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/66
* Update to latest API changes by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/67
* Ship our own root certificate until we have a proper one by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/68
* Update dispatch API by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/69
* Update to dispatch API v0.15.0 by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/70


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-dispatch-python/compare/v0.4.0...v0.5.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 https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/55
* Reset releasenotes by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/54
* Implement key-based authentication by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/56
* Prepare for release by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/58


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

Frequenz Dispatch Client Library Release Notes

Summary

Most notable feature is the addion of the CLI/REPL client.

New Features

* A CLI/REPL client was added. Run it using `python -m frequenz.client.dispatch` or just `dispatch-cli` if the package was installed in your path. Use the `--help` parameter to get an overview of the available commands.

Bug Fixes

* Fixed that client.update() was ignoring updates to "payload".


What's Changed
* Bump the required group with 8 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/40
* Unpin sybil by llucax in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/42
* Bump the required group with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/41
* Fail the `nox-cross-arch-all` job if any matrix job fails by llucax in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/43
* Don't recursively scan for pyproject.toml when calculating the cache key by llucax in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/44
* Reset release notes by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/47
* Implement a CLI and REPL dispatch client by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/46
* Install dispatch client as "dispatch-cli" by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/50
* Support payload and recurrence flags in CLI/REPL by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/48
* Bump the required group with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/52
* Implement cli recurrence update by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/51
* Prepare release notes for release by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/53


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

Frequenz Dispatch Client Library Release Notes

Summary

This release contains a few breaking changes that were required to enhance the
API.

Upgrading

- The `Dispatch` class is now a frozen dataclass, meaning that it is immutable. Modifications can still be done using `replace`: `dispatch = replace(dispatch, start_time=new_start_time)`.
- The `Client.update()` method now requires named parameters.
- `Client.update()` no longer accepts changes to the `type` and `dry_run` fields.

New Features

- A new module `frequenz.client.dispatch.test` has been added, providing a fake Service and Client as well as a `DispatchGenerator` to generate `Dispatch` instances filled with random data.
- The `DispatchGenerator.generate_dispatch` method now accepts a `microgrid_id` parameter to generate `Dispatch` instances with a specific microgrid ID.
- The `Client.create()` method now returns the newly created `Dispatch` object.


What's Changed
* Apply missing upgrade-step after repo-config update by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/20
* Bump grpc-stubs from 1.53.0.2 to 1.53.0.5 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/23
* Bump the optional group with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/24
* Downgrade pytest as release was yanked by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/25
* Make test classes available by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/21
* Useful additions for testing by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/26
* Fix the Python package name by llucax in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/27
* Bump nox from 2023.4.22 to 2024.3.2 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/30
* Bump the optional group with 11 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/31
* Make `Dispatch` class frozen by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/32
* Make `Client.update` require named parameters by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/34
* Disallow updating `type` and `dry_run` by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/35
* Use client-common v0.1.0 and api-dispatch v0.13.0 by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/36
* Enhancements to the interface and bugfixes by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/37
* Prepare release notes by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/38
* Update api-reference in docs by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/39


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