Frequenz-dispatch

Dispatch Highlevel Interface Release Notes

Summary

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

Upgrading

- The dispatch high level interface now depends on `frequenz-sdk` version `v1.0.0-rc900`.
- We are now using the version `0.6.0` of the underlying `frequenz-client-dispatch` client library.
- The init parameter of the `Dispatcher` class has been changed to accept a `server_url` instead.

New Features

* Using the new dispatch client, we now have support for pagination in the dispatch list request.
* The new client version also supports streaming, however it is not yet used internally in the high level interface.

Bug Fixes

- Fix documentation cross-linking to the `frequenz-client-dispatch` package.


What's Changed
* Bump the cross-ref object DB version to match the dependency version by llucax in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/42
* Bump the required group with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/43
* Update frequenz-SDK to 1.0.0-rc801 by daniel-zullo-frequenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/46
* Configure the new label by llucax in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/48
* Bump the required group with 14 updates by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/49
* Bump types-python-dateutil from 2.9.0.20240316 to 2.9.0.20240821 by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/50
* Update to latest SDK and dispatch-client versions by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/51

New Contributors
* daniel-zullo-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/46

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

Dispatch Highlevel Interface Release Notes

Upgrading

* An API key for authorization must now be passed to the client.


What's Changed
* Reset Release Notes after release by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/31
* Bump the required group with 11 updates by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/32
* Add key authentication by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/34
* Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/35
* Bump docker/build-push-action from 5 to 6 by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/36
* Bump the required group with 9 updates by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/37
* Update to new client by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/39
* Update to client v0.5.0 by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/40


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

Dispatch Highlevel Interface Release Notes

Summary

This is the first release of the highlevel dispatch interface!

Upgrading

* `Dispatcher.ready_to_execute()` was renamed to `Dispatcher.running_status_change()`

New Features

* Introduced new class `Dispatch` (based on the client class) that contains useful functions and extended information about the received dispatch.
* `Dispatcher.client` was added to provide an easy access to the client for updating, deleting and creating dispatches


What's Changed
* Fix todos by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/8
* Bump the optional group with 16 updates by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/10
* Bump the optional group with 1 update by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/11
* Initial structure by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/9
* Add gRPC Python API cross referencing by llucax in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/14
* Improve project structure by llucax in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/15
* Update solipsism by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/12
* Bump the optional group with 12 updates by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/18
* Bump the optional group with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/20
* Update frequenz dependencies by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/23
* Remove explicit dependency on sybil by llucax in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/26
* Bump the required group across 1 directory with 9 updates by dependabot in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/27
* Make `ready_to_execute` channel more general by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/22
* Don't recursively scan for pyproject.toml when calculating the cache key by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/29
* Prepare release notes by Marenz in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/30

New Contributors
* Marenz made their first contribution in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/8
* dependabot made their first contribution in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/10
* llucax made their first contribution in https://github.com/frequenz-floss/frequenz-dispatch-python/pull/14

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