Frequenz-client-dispatch

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

This is the first release of the Dispatch API client! :partying_face:

What's Changed
* Init with repo-config by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/1
* Bump actions/download-artifact from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/6
* Create initial structure by Marenz in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/14
* Bump flake8 from 6.1.0 to 7.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/10
* Bump the optional group with 14 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/17
* Bump black from 23.9.1 to 24.2.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/18
* Bump pytest from 7.4.2 to 8.0.1 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/16
* Bump actions/setup-python from 4 to 5 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/2
* Bump actions/cache from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/3
* Bump actions/labeler from 4.3.0 to 5.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/5
* docs: Add cross-referencing for gRPC by llucax in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/19

New Contributors
* Marenz made their first contribution in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/1
* dependabot made their first contribution in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/6
* llucax made their first contribution in https://github.com/frequenz-floss/frequenz-client-dispatch-python/pull/19

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