Fix copyright and docstring for __init__.py files

llucax · llucax · commit 06baf70b23b9 · 2025-06-17T11:46:36.000+02:00
Some files where missing the copyright notice completely, some files
have the wrong copyright year, some files had some TODOs in the
docstring and most had a bad or outdated docstring.

Signed-off-by: Leandro Lucarella &lt;luca-frequenz@llucax.com&gt;
diff --git a/py/frequenz/api/common/__init__.py b/py/frequenz/api/common/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Frequenz common gRPC API and bindings."""
diff --git a/py/frequenz/api/common/metrics/__init__.py b/py/frequenz/api/common/metrics/__init__.py
@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz Common API definitions for metrics."""
+"""Metrics bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1/__init__.py b/py/frequenz/api/common/v1/__init__.py
@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings."""
+"""Frequenz common gRPC API and bindings for v1."""
diff --git a/py/frequenz/api/common/v1/grid/__init__.py b/py/frequenz/api/common/v1/grid/__init__.py
@@ -0,0 +1,4 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Grid bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1/market/__init__.py b/py/frequenz/api/common/v1/market/__init__.py
@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings."""
+"""Market bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1/metrics/__init__.py b/py/frequenz/api/common/v1/metrics/__init__.py
@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz Common API definitions for metrics."""
+"""Metrics bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1/microgrid/__init__.py b/py/frequenz/api/common/v1/microgrid/__init__.py
@@ -0,0 +1,4 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Microgrid bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1/microgrid/components/__init__.py b/py/frequenz/api/common/v1/microgrid/components/__init__.py
@@ -0,0 +1,4 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Components bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1/microgrid/sensors/__init__.py b/py/frequenz/api/common/v1/microgrid/sensors/__init__.py
@@ -0,0 +1,4 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Sensors bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1/pagination/__init__.py b/py/frequenz/api/common/v1/pagination/__init__.py
@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings."""
+"""Pagination bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1/types/__init__.py b/py/frequenz/api/common/v1/types/__init__.py
@@ -0,0 +1,4 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Types bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/__init__.py b/py/frequenz/api/common/v1alpha7/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Frequenz common gRPC API and bindings for v1alpha7."""
diff --git a/py/frequenz/api/common/v1alpha7/grid/__init__.py b/py/frequenz/api/common/v1alpha7/grid/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Grid bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/market/__init__.py b/py/frequenz/api/common/v1alpha7/market/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Market bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/metrics/__init__.py b/py/frequenz/api/common/v1alpha7/metrics/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Metrics bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/microgrid/__init__.py b/py/frequenz/api/common/v1alpha7/microgrid/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Microgrid bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/microgrid/communication_components/__init__.py b/py/frequenz/api/common/v1alpha7/microgrid/communication_components/__init__.py
@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings."""
+"""Communication components bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/microgrid/electrical_components/__init__.py b/py/frequenz/api/common/v1alpha7/microgrid/electrical_components/__init__.py
@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings."""
+"""Electrical components bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/microgrid/sensors/__init__.py b/py/frequenz/api/common/v1alpha7/microgrid/sensors/__init__.py
@@ -1,4 +1,4 @@
 # License: MIT
 # Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings."""
+"""Sensors bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/pagination/__init__.py b/py/frequenz/api/common/v1alpha7/pagination/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Pagination bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/streaming/__init__.py b/py/frequenz/api/common/v1alpha7/streaming/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Streaming bindings for Frequenz common gRPC API."""
diff --git a/py/frequenz/api/common/v1alpha7/type/__init__.py b/py/frequenz/api/common/v1alpha7/type/__init__.py
@@ -1,7 +1,4 @@
 # License: MIT
-# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz common gRPC API and bindings.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""Type bindings for Frequenz common gRPC API."""
