Skip to content

Commit 14a0a63

Browse files
authored
Clean RELEASE_NOTES (#79)
2 parents 5138200 + 011b170 commit 14a0a63

File tree

1 file changed

+5
-79
lines changed

1 file changed

+5
-79
lines changed

RELEASE_NOTES.md

Lines changed: 5 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -2,90 +2,16 @@
22

33
## Summary
44

5-
The project has a new home!
6-
7-
https://frequenz-floss.github.io/frequenz-sdk-python/
8-
9-
For now the documentation is pretty scarce but we will be improving it with
10-
time.
11-
12-
The most prominent changes in this release is the cleanup of the public API,
13-
which is much more concise and clear now and the addition of classes
14-
implementing the new data flow design, in particular the `DataSourcingActor`
15-
and the `ComponentMetricsResamplingActor`.
5+
<!-- Here goes a general summary of what this release is about -->
166

177
## Upgrading
188

19-
* `EVChargerData`'s `active_power_consumption` has been renamed to `active_power`
20-
21-
* `PowerDistributor` - type of `Request`'s `request_timeout_sec` has been changed from `int` to `float`
22-
23-
* `ComponentCategory.LOAD` has been added
24-
25-
* The
26-
[`frequenz-channels`](https://github.com/frequenz-floss/frequenz-channels-python/)
27-
was upgraded to
28-
[v0.11.0](https://github.com/frequenz-floss/frequenz-channels-python/releases/tag/v0.11.0)
29-
which includes a bunch of [breaking
30-
changes](https://github.com/frequenz-floss/frequenz-channels-python/blob/v0.11.0/RELEASE_NOTES.md#upgrading-breaking-changes)
31-
you should be aware of.
32-
33-
* The public API has been cleaned up, several symbols were moved or exposed in
34-
a single module, and some symbols were hidden because they are either
35-
schedule for deprecation or not yet stabilized.
36-
37-
* `frequenz.sdk.actor`: The `decorator` sub-module was hidden and now the
38-
`@actor` decorator is exposed directly only in the main module.
39-
40-
* `frequenz.sdk.configs`: was renamed to `frequenz.sdk.config`, `Config` is
41-
only exposed in the main module and the `ConfigManager` was moved to
42-
`frequenz.sdk.actor.ConfigManagingActor`.
43-
44-
* The modules `frequenz.sdk.data_handling` and `frequenz.sdk.data_ingestion`
45-
were hidden from the public interface and will probably be removed in the
46-
future. They are still available as `frequenz.sdk._data_handling` and
47-
`frequenz.sdk._data_ingestion` for users still needing them.
48-
49-
* The module `frequenz.sdk.power_distribution` was renamed to
50-
`frequenz.sdk.power` and the `PowerDistributor` was moved to
51-
`frequenz.sdk.actor.power_distributing.PowerDistributingActor` (with the
52-
utility classes `Request` and `Result`).
53-
54-
* The module `frequenz.sdk.microgrid` was simplified.
55-
56-
* All component-related symbols (`.component`, `.component_data`,
57-
`.component_states`) were moved to the sub-module
58-
`frequenz.sdk.microgrid.component`.
59-
60-
* All API client-related symbols (`.client`, `.connection`, `.retry`) were
61-
moved to the sub-module `frequenz.sdk.microgrid.client`.
62-
63-
* The `ComponentGraph` is exposed directly in the main module (and only
64-
there).
65-
66-
* The `microgrid_api` module is now exposed via the main module directly
67-
(and thus indirectly renamed to `microgrid`, so instead of using `from
68-
frequenz.sdk.microgrid import microgrid_api; microgrid_api.initialize()`
69-
(for example) you should use `from frequenz.sdk.microgrid import
70-
microgridi; microgrid.initialize()`.
71-
72-
* The `MicrogridApi` class was renamed to `Microgrid` to make it clear it
73-
is not exclusively about the API.
74-
75-
* The `Microgrid.microgrid_api_client` attribute was renamed to
76-
`Microgrid.api_client` to avoid the redundancy.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
7710

7811
## New Features
7912

80-
* `MeterData` objects now expose the AC `frequency` measured by the meter.
81-
82-
* `BatteryData` objects now expose the temperature of the hottest block in the
83-
battery as `temperature_max`
84-
85-
* A new `frequenz.sdk.actor.DataSourcingActor` was added.
86-
87-
* A new `frequenz.sdk.actor.ComponentMetricsResamplingActor` was added.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
8814

89-
* A new `frequenz.sdk.actor.ChannelRegistry` was added.
15+
## Bug Fixes
9016

91-
* A new module `frequenz.sdk.timeseries` was added.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)