v0.12.0

[github-actions[bot]]

Release Notes

Summary

The project has a new home!

https://frequenz-floss.github.io/frequenz-sdk-python/

For now the documentation is pretty scarce but we will be improving it with
time.

The most prominent changes in this release is the cleanup of the public API,
which is much more concise and clear now and the addition of classes
implementing the new data flow design, in particular the DataSourcingActor
and the ComponentMetricsResamplingActor.

Upgrading

• EVChargerData's active_power_consumption has been renamed to active_power

• PowerDistributor - type of Request's request_timeout_sec has been changed from int to float

• ComponentCategory.LOAD has been added

• The
  frequenz-channels
  was upgraded to
  v0.11.0
  which includes a bunch of breaking
  changes
  you should be aware of.

• The public API has been cleaned up, several symbols were moved or exposed in
  a single module, and some symbols were hidden because they are either
  schedule for deprecation or not yet stabilized.

  • frequenz.sdk.actor: The decorator sub-module was hidden and now the
    @actor decorator is exposed directly only in the main module.

  • frequenz.sdk.configs: was renamed to frequenz.sdk.config, Config is
    only exposed in the main module and the ConfigManager was moved to
    frequenz.sdk.actor.ConfigManagingActor.

  • The modules frequenz.sdk.data_handling and frequenz.sdk.data_ingestion
    were hidden from the public interface and will probably be removed in the
    future. They are still available as frequenz.sdk._data_handling and
    frequenz.sdk._data_ingestion for users still needing them.

  • The module frequenz.sdk.power_distribution was renamed to
    frequenz.sdk.power and the PowerDistributor was moved to
    frequenz.sdk.actor.power_distributing.PowerDistributingActor (with the
    utility classes Request and Result).

  • The module frequenz.sdk.microgrid was simplified.

    • All component-related symbols (.component, .component_data,
      .component_states) were moved to the sub-module
      frequenz.sdk.microgrid.component.

    • All API client-related symbols (.client, .connection, .retry) were
      moved to the sub-module frequenz.sdk.microgrid.client.

    • The ComponentGraph is exposed directly in the main module (and only
      there).

    • The microgrid_api module is now exposed via the main module directly
      (and thus indirectly renamed to microgrid, so instead of using from frequenz.sdk.microgrid import microgrid_api; microgrid_api.initialize()
      (for example) you should use from frequenz.sdk.microgrid import microgridi; microgrid.initialize().

    • The MicrogridApi class was renamed to Microgrid to make it clear it
      is not exclusively about the API.

    • The Microgrid.microgrid_api_client attribute was renamed to
      Microgrid.api_client to avoid the redundancy.

New Features

• MeterData objects now expose the AC frequency measured by the meter.

• BatteryData objects now expose the temperature of the hottest block in the
  battery as temperature_max

• A new frequenz.sdk.actor.DataSourcingActor was added.

• A new frequenz.sdk.actor.ComponentMetricsResamplingActor was added.

• A new frequenz.sdk.actor.ChannelRegistry was added.

• A new module frequenz.sdk.timeseries was added.

What's Changed

• Clear RELEASE_NOTES.md by @leandro-lucarella-frequenz in Clear RELEASE_NOTES.md #23
• Change the type of Request's request_timeout_sec to float by @jkozlowicz in Change the type of Request's request_timeout_sec to float #13
• Rename active_power_consumption to active_power in context of EVCharger by @jkozlowicz in Rename active_power_consumption to active_power in context of EVCharger #17
• Add LOAD component category by @jkozlowicz in Add LOAD component category #26
• Implement ChannelRegistry by @sahas-subramanian-frequenz in Implement ChannelRegistry #25
• Change component data wrappers to be data classes by @jkozlowicz in Change component data wrappers to be data classes #4
• Remove timeout for receiving from client handle to prevent flakiness by @jkozlowicz in Remove timeout for receiving from client handle to prevent flakiness #18
• ChannelRegistry improvements by @shsms in ChannelRegistry improvements #29
• Fix EVChargerData's from_proto method by @sahas-subramanian-frequenz in Fix EVChargerData's from_proto method #35
• Add new labels to the CI and issue templates by @leandro-lucarella-frequenz in Add new labels to the CI and issue templates #46
• Add timeout to all gRPC calls and set a default timeout by @jkozlowicz in Add timeout to all gRPC calls and set a default timeout #50
• Add DataSourcingActor by @shsms in Add DataSourcingActor #52
• Update noxfile.py to run darglint in verbose-mode by @sahas-subramanian-frequenz in Update noxfile.py to run darglint in verbose-mode #51
• Add a resampling actor by @jkozlowicz in Add a resampling actor #32
• Indent multi-line return value descriptions in docstrings by @shsms in Indent multi-line return value descriptions in docstrings #54
• Clean ups and improvements to the resampler (mostly) by @leandro-lucarella-frequenz in Clean ups and improvements to the resampler (mostly) #68
• Generate and publish API docs by @leandro-lucarella-frequenz in Generate and publish API docs #72
• Update the SDK codebase to work with the latest channel version by @shsms in Update the SDK codebase to work with the latest channel version #76
• Expose additional fields from ComponentData streams by @shsms in Expose additional fields from ComponentData streams #75
• Upgrade dependency to frequenz-channels v0.11.0 by @leandro-lucarella-frequenz in Upgrade dependency to frequenz-channels v0.11.0 #77
• Cleanup public interface by @leandro-lucarella-frequenz in Cleanup public interface #78

New Contributors

• @jkozlowicz made their first contribution in Change the type of Request's request_timeout_sec to float #13
• @sahas-subramanian-frequenz made their first contribution in Implement ChannelRegistry #25
• @shsms made their first contribution in ChannelRegistry improvements #29

Full Changelog: v0.11.0...v0.12.0

---

This discussion was created from the release v0.12.0.