v0.6.0

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

• Rename CLI trade and order functions for clarity
  • Rename receive_trades to receive_public_trades
  • Rename receive_orders to receive_gridpool_orders

• The stream_* methods in the client have been renamed to *_stream. They no longer return Receiver instances, but rather GrpcStreamBroadcaster instances. They expose a new_receiver() method which can be used to get a new receiver. They also expose a stop() method which can be used to stop the background streaming task when the stream is no longer needed.

New Features

• Print tags and filled (instead of open) quantity for gridpool orders in CLI tool.

Bug Fixes

What's Changed

• Print tags on orders in CLI tool by @cwasicki in #107
• Rename CLI commands for clarity by @camille-bouvy-frequenz in #108
• Return GrpcStreamBroadcaster instances from the streaming methods by @shsms in #110

Full Changelog: v0.5.1...v0.6.0

v0.5.1

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

New Features

• Add helper function to support creating quantities that conform to the API expectations.
• Add receive-gridpool-trades command to CLI tool.
• Add the warn_on_overflow option to the streaming receivers to allow ignoring overflow warnings
• Add the max_size option to the streaming receivers

Bug Fixes

What's Changed

• Add utils module with quantity quantization helper by @cwasicki in #105
• Add receive-gridpool-trades command to CLI tool by @cwasicki in #104
• Add options to the streaming receivers by @camille-bouvy-frequenz in #106

Full Changelog: v0.5.0...v0.5.1

v0.5.0

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

New Features

• Use decorator for from_pb methods to ensure an error message with protobuf data is logged in case there are conversion problems.

Bug Fixes

• Deal correctly with cancelled orders with no price or quantity

What's Changed

• Log protobuf conversion issues by @cwasicki in #101
• Support orders without price or quantity by @cwasicki in #103

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

v0.3.1

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

New Features

• Extra validation check to ensure the quantity is strictly positive.
• Extra validation check to ensure the quantity and price are within the allowed bounds.
• Add more edge cases to the integration tests.
• Add idiomatic string representations for Power and Price classes.
• Add support for timeouts in the gRPC function calls
• Export Client constants for external use
• Fetch subsequent paginated data for list_* methods

Bug Fixes

What's Changed

• Reset Release Notes after release v0.3.0 by @camille-bouvy-frequenz in #69
• Upgrade base client minimum required dependency from v0.7.0 to v0.8.0 by @camille-bouvy-frequenz in #73
• Bump the required group with 6 updates by @dependabot in #74
• Bump setuptools from 68.1.0 to 75.6.0 by @dependabot in #75
• Bump setuptools-scm[toml] from 7.1.0 to 8.1.0 by @dependabot in #76
• Integration test edge cases by @camille-bouvy-frequenz in #70
• Add __str__ methods for the Price and Power classes by @shsms in #78
• Replace Energy with Power in initialisation examples by @camille-bouvy-frequenz in #79
• Add tests for str formatting of Price and Power types by @shsms in #81
• Add timeout to gRPC requests by @camille-bouvy-frequenz in #72
• Export Client constants for external use by @camille-bouvy-frequenz in #83
• Fetch subsequent paginated data on list_* functions by @camille-bouvy-frequenz in #82
• Fix the formatting of the integration tests by @camille-bouvy-frequenz in #84

Full Changelog: v0.3.0...v0.3.1

v0.3.0

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

• Update base client from version 0.6.1 to 0.7.0 and upgrade the Client constructor accordingly.

New Features

• Add str function for DeliveryPeriod object
• Add integration tests for the API
• Add an equality function to the Order type

Bug Fixes

What's Changed

• Fix documentation website link in README.md by @camille-bouvy-frequenz in #61
• Update examples to use asyncio event loop by @daniel-zullo-frequenz in #62
• Bump the required group with 8 updates by @dependabot in #64
• Add __str__ method for DeliveryPeriod by @camille-bouvy-frequenz in #67
• Add integration tests by @camille-bouvy-frequenz in #53
• Update base client to v0.7.0 by @camille-bouvy-frequenz in #66

Full Changelog: v0.2.5...v0.3.0

v0.2.5

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

New Features

• Replace assert statements with proper exception handling
• Implement client instance reuse to avoid redundant TCP connections
• Move documentation and code examples to the documentation website
• Replace the local PaginationParams type with the frequenz-client-common one
• Remove dependency to googleapis-common-protos
• Replace Energy with Power for the quantity representation

Bug Fixes

What's Changed

• Reset Release Notes after update to v0.2.4 by @camille-bouvy-frequenz in #51
• Replace assert statements with proper exception handling by @camille-bouvy-frequenz in #54
• Implement client instance reuse to avoid redundant TCP connections by @camille-bouvy-frequenz in #56
• Move documentation and code examples to the documentation website by @camille-bouvy-frequenz in #52
• Validate init examples with sybil by @Marenz in #57
• Bump the required group with 4 updates by @dependabot in #55
• Replace the local PaginationParams type with the frequenz-client-common one by @camille-bouvy-frequenz in #58
• Remove the dependency on googleapis by @camille-bouvy-frequenz in #59
• Replace Energy with Power for the quantity representation by @camille-bouvy-frequenz in #60

Full Changelog: v0.2.4...v0.2.5

v0.2.4

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

New Features

• Add input validation checks for price, quantity, delivery_period, valid_until, execution_option and order_type.
• Add unit tests for requests with invalid input parameters.
• Updated dependencies to latest versions

Bug Fixes

• Fix variable name max_nr_orders to max_nr_trades for trades requests

What's Changed

• Clear release notes after releasing v0.2.3 by @daniel-zullo-frequenz in #38
• Add input validation checks for the Client Requests by @camille-bouvy-frequenz in #40
• Add a validation rule for order execution options by @camille-bouvy-frequenz in #44
• Update to latest version for a bunch of dependencies by @Marenz in #45
• Add rules for order_type + unit tests for validation rules by @camille-bouvy-frequenz in #47
• Fix variable name max_nr_orders to max_nr_trades for trades requests by @camille-bouvy-frequenz in #48
• Bump deepdiff from 7.0.1 to 8.0.1 by @dependabot in #43
• Bump the required group across 1 directory with 12 updates by @camille-bouvy-frequenz in #50
• Bump the required group across 1 directory with 12 updates by @dependabot in #49

New Contributors

• @Marenz made their first contribution in #45

Full Changelog: v0.2.3...v0.2.4

v0.2.3

Frequenz Electricity Trading API Client Release Notes

Bug Fixes

• Fixed list gridpool orders to log an error when an order conversion from protobuf failed and continuing to process other orders.

What's Changed

• Clear release notes by @daniel-zullo-frequenz in #35
• Fix minor issues found in a code session with Ostrom by @daniel-zullo-frequenz in #36
• Fix list gridpool orders by @daniel-zullo-frequenz in #37

Full Changelog: v0.2.2...v0.2.3

v0.2.2

Frequenz Electricity Trading API Client Release Notes

Summary

Upgrading

• Refactor order states following frequenz-api-electricity-trading update to :

  • Remove obsolete order states CANCEL_REQUESTED and CANCEL_REJECTED

• The minimum required version of frequenz-client-base is now 0.3

• The minimum required version of frequenz-channels is now 1.0

New Features

• Restrict the decimal points of the quantity and price values

• Integrate the BaseApiClient v0.5 into the client

• Add key based authorization to the client

Bug Fixes

• Handle missing protobuf fields in Filter classes

What's Changed

• Fix publishing packaging error by @daniel-zullo-frequenz in #34

Full Changelog: v0.2.1...v0.2.2

v0.1.0

Frequenz Electricity Trading API Client Release Notes

Summary

This is the first release of the Frequenz Electricity Trading API Client for Python on this repo. The code was imported from frequenz-api-electricity-trading v0.1.3, and some minor changes were made to adapt it to the updated dependencies.

What's Changed

• Bump actions/cache from 3 to 4 by @dependabot in #1
• Bump actions/setup-python from 4 to 5 by @dependabot in #3
• Bump the required group with 13 updates by @dependabot in #5
• Bump nox from 2023.4.22 to 2024.4.15 by @dependabot in #7
• Bump deepdiff from 6.7.1 to 7.0.1 by @dependabot in #6
• Update frequenz-channels requirement from <0.17.0,>=0.16.0 to >=0.16.0,<1.1.0 by @dependabot in #9
• Bump black from 23.12.1 to 24.4.0 by @camille-bouvy-frequenz in #10
• Update Release Notes for release v0.1.0 by @camille-bouvy-frequenz in #11

New Contributors

• @dependabot made their first contribution in #1
• @camille-bouvy-frequenz made their first contribution in #10

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