v0.3.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 #40
• Unpin sybil by @llucax in #42
• Bump the required group with 3 updates by @dependabot in #41
• Fail the nox-cross-arch-all job if any matrix job fails by @llucax in #43
• Don't recursively scan for pyproject.toml when calculating the cache key by @llucax in #44
• Reset release notes by @Marenz in #47
• Implement a CLI and REPL dispatch client by @Marenz in #46
• Install dispatch client as "dispatch-cli" by @Marenz in #50
• Support payload and recurrence flags in CLI/REPL by @Marenz in #48
• Bump the required group with 10 updates by @dependabot in #52
• Implement cli recurrence update by @Marenz in #51
• Prepare release notes for release by @Marenz in #53

Full Changelog: v0.2.0...v0.3.0

v0.2.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 #20
• Bump grpc-stubs from 1.53.0.2 to 1.53.0.5 by @dependabot in #23
• Bump the optional group with 7 updates by @dependabot in #24
• Downgrade pytest as release was yanked by @Marenz in #25
• Make test classes available by @Marenz in #21
• Useful additions for testing by @Marenz in #26
• Fix the Python package name by @llucax in #27
• Bump nox from 2023.4.22 to 2024.3.2 by @dependabot in #30
• Bump the optional group with 11 updates by @dependabot in #31
• Make Dispatch class frozen by @Marenz in #32
• Make Client.update require named parameters by @Marenz in #34
• Disallow updating type and dry_run by @Marenz in #35
• Use client-common v0.1.0 and api-dispatch v0.13.0 by @Marenz in #36
• Enhancements to the interface and bugfixes by @Marenz in #37
• Prepare release notes by @Marenz in #38
• Update api-reference in docs by @Marenz in #39

Full Changelog: v0.1.0...v0.2.0

v0.1.0

This is the first release of the Dispatch API client! 🥳

What's Changed

• Init with repo-config by @Marenz in #1
• Bump actions/download-artifact from 3 to 4 by @dependabot in #6
• Create initial structure by @Marenz in #14
• Bump flake8 from 6.1.0 to 7.0.0 by @dependabot in #10
• Bump the optional group with 14 updates by @dependabot in #17
• Bump black from 23.9.1 to 24.2.0 by @dependabot in #18
• Bump pytest from 7.4.2 to 8.0.1 by @dependabot in #16
• Bump actions/setup-python from 4 to 5 by @dependabot in #2
• Bump actions/cache from 3 to 4 by @dependabot in #3
• Bump actions/labeler from 4.3.0 to 5.0.0 by @dependabot in #5
• docs: Add cross-referencing for gRPC by @llucax in #19

New Contributors

• @Marenz made their first contribution in #1
• @dependabot made their first contribution in #6
• @llucax made their first contribution in #19

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