Frequenz-api-electricity-trading

Frequenz Electricity Trading API Release Notes

Summary

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

Upgrading

- Refactor order states:
- Add new order state PARTIALLY_FILLED_AND_CANCELED
- Remove obsolete order states CANCEL_REQUESTED and CANCEL_REJECTED

New Features

<!-- Here goes the main new features and examples or instructions on how to use them -->

Bug Fixes

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


What's Changed
* Reset release notes after v0.2.0 by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/69
* Bump submodules/api-common-protos from `2aec9e1` to `25a31d8` by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/63
* Refactor the Order states by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/70


**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-electricity-trading/compare/v0.2.0...v0.2.1

Frequenz Electricity Trading API Release Notes

Summary

All the files related to the python Client (in the `py/frequenz/client/` folder) are removed from this repo, as they are moved to the `frequenz-floss/frequenz-client-electricity-trading-python` repo.


What's Changed
* Update release notes for release v0.1.3 by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/66
* Reset release notes after release v0.1.3 by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/67
* Remove all the files related to the Client API from this repo by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/68


**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-electricity-trading/compare/v0.1.3...v0.2.0

Frequenz Electricity Trading API Release Notes

Summary

Key improvements of this release include a clear a distinction between Order and Trade in the protobuf definitions, improved handling of delivery period, gRPC error handling in the client and unit tests for the client types and functions.


New Features

* Make a distinction between Order and Trade in the protobuf definitions
* Introduction of new endpoints to retrieve gridpool trades
* Addition of new definitions and support for trade state filters and streaming
* Refactor DeliveryPeriod to take in a timedelta duration attribute instead of the DeliveryDuration Enum type
* Public trades renamed from public_trade_lists to public trades and all _lists suffixes removed
* Remove ORDER_EXECUTION_OPTION_NONE from OrderExecutionOption
* Add unit tests for the client types and functions
* Add error handling in the client for the gRPC errors that could be raised by the service


Bug Fixes

* Remove `frequenz-api-common` files now that dependency conflict is solved
* Fix DeliveryArea from and to pb methods
* Use HasFields method on protobuf messages
* Make the `DeliveryPeriod` and all `Filter` types hashable
* Force all timestamps to be timezone aware and UTC
* Refactor some protofub timestamps that were falsly returning None values in the client


What's Changed
* Revert 24: Remove files from `frequenz-api-common` by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/41
* Add Gridpool Trades to protobuf definition by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/42
* Bump submodules/api-common-protos from `8681efd` to `2aec9e1` by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/34
* Bump actions/cache from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/35
* Bump types-markdown from 3.5.0.3 to 3.5.0.20240129 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/40
* Bump flake8 from 6.1.0 to 7.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/39
* Adapt the Client with the new Gridpool Trades definition and functions by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/43
* Bump yoheimuta/action-protolint from 1.2.0 to 1.3.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/49
* Add `frequenz-api-common` submodule and remove its local proto files by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/48
* Fix DeliveryArea from and to pb methods by matthias-wende-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/52
* Use HasField method on protobuf messages by matthias-wende-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/53
* Refactor DeliveryDuration to Accept timedelta by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/46
* Minor refactoring of DeliveryDuration using match-case by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/54
* Fix state of PublicTrade from OrderState to TradeState by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/56
* Rename public_trade_lists and add documentation to PublicTrade message by idlir-shkurti-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/47
* Remove _list suffixes in the client by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/59
* Remove ORDER_EXECUTION_OPTION_NONE from OrderExecutionOption by matthias-wende-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/61
* Add `__eq__` function to DeliveryPeriod type by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/64
* Add unit tests to the client and fix related bugs by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/55
* Add __init__.py files to "frequenz/api/common/v1" folder by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/65

New Contributors
* idlir-shkurti-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/47

**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-electricity-trading/compare/v0.1.2...v0.1.3

Frequenz Electricity Trading API Release Notes

Summary

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

Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

New Features

<!-- Here goes the main new features and examples or instructions on how to use them -->

Bug Fixes

* Fix bug type for `EnergyMarketCodeType`


What's Changed
* Fix bug type in EnergyMarketCodeType by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/32


**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-electricity-trading/compare/v0.1.1...v0.1.2

Frequenz Electricity Trading API Release Notes

Summary

This API interface's client requires the SDK, which depends on
frequenz-api-common in the version range of 0.3.0 to < 0.4.0. However,
electricity_trading.proto needs some proto files from frequenz-api-common,
which are only available from version 0.5.0. This discrepancy creates
a dependency conflict. To resolve this, the current PR incorporates
the required protos directly from the frequenz-api-common repository and
stores them locally. This approach eliminates the dependency on the common
repository for the time being, until the SDK is updated to a newer version
of frequenz-api-common.

A couple of additions were also made to the `__init__` and `_types.py` files.


Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

New Features

* Addition of missing types to the `__init__` file
* Addition of missing `to_pb()` methods in the `_types.py` file

Bug Fixes

* Remove dependency conflict on `frequenz-api-common` by adding it locally
* Add a py.typed file


What's Changed
* Reset release notes after the first release by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/22
* Add missing types to __init__ file by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/23
* Temporarily remove dependency on `frequenz-api-common` by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/24
* Minor changes to `__init__` and `_types.py` by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/26


**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-electricity-trading/compare/v0.1.0...v0.1.1

Frequenz Electricity Trading API Release Notes

Summary

This is the first release of the Electricity Trading API.

It includes protobuf definitions of the Electricity Trading API and a python client with support for streaming of orders and public trades.


New Features

- Update of the common repository with the latest Electricity related changes.
- Use googleapis repository instead of api-common-protos.
- Update to latest repo config v0.8.
- Commiting the electricity trading api specs.
- Rename PublicOrders to PublicTrades
- Add a python client with pyton wrappers for methods & classes and support for streaming orders.


What's Changed
* Add initial protobuf definitions by david-natingga-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/1
* Rename PublicOrders to PublicTrades by matthias-wende-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/11
* Bump actions/setup-python from 4 to 5 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/3
* Bump grpc-stubs from 1.53.0.2 to 1.53.0.5 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/8
* Bump actions/labeler from 4.3.0 to 5.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/2
* Bump submodules/api-common-protos from `e56f4b1` to `75c4411` by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/9
* Bump actions/download-artifact from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/4
* Bump actions/upload-artifact from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/5
* Fix labeler action by matthias-wende-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/13
* Bump yoheimuta/action-protolint from 1.0.0 to 1.2.0 by matthias-wende-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/12
* Bump submodules/api-common-protos from `75c4411` to `8681efd` by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/14
* Bump actions/checkout from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/15
* Bump the optional group with 11 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/10
* Implement Electricity Trading API Client and type wrappers by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/16
* Add unit conversion methods to Energy type by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/18
* Revert 18 Add unit conversion methods to Energy type by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/20
* Remove unnecessary optional keywords and add documentation by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/21

New Contributors
* david-natingga-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/1
* matthias-wende-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/11
* dependabot made their first contribution in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/3
* camille-bouvy-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-api-electricity-trading/pull/16

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