Add frequenz-api-common to the default submodules

Practically all API clients will need to include `frequenz-api-common`,
and for the ones who don't, it is much easier to remove stuff thant to
add it.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

cookiecutter/{{cookiecutter.github_repo_name}}/.gitmodules

@@ -2,4 +2,7 @@
 [submodule "submodules/api-common-protos"]
 	path = submodules/api-common-protos
 	url = https://github.com/googleapis/api-common-protos.git
+[submodule "frequenz-api-common"]
+	path = submodules/frequenz-api-common
+	url = https://github.com/frequenz-floss/frequenz-api-common.git
 {% endif -%}

cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

@@ -38,6 +38,7 @@ dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
 ]
 {%- elif cookiecutter.type == "api" %}
 dependencies = [ # TODO(cookiecutter): Remove and add more if appropriate
+  "frequenz-api-common >= 0.2.0, < 0.3.0",
   "googleapis-common-protos >= 1.56.2, < 2",
   "grpcio >= 1.51.1, < 2",
 ]

src/frequenz/repo/config/__init__.py

@@ -1,7 +1,7 @@
 # License: MIT
 # Copyright © 2023 Frequenz Energy-as-a-Service GmbH
 
-"""Frequenz project setup tools and common configuration.
+r"""Frequenz project setup tools and common configuration.
 
 The tools are provided to configure the main types of repositories most commonly used at
 Frequenz, defined in
@@ -166,15 +166,21 @@
 - `pytests/`: Directory containing the tests for the Python code.
 - `submodules/api-common-protos`: Directory containing the submodule with the
   `google/api-common-protos` repository.
+- `submodules/frequenz-api-common`: Directory containing the submodule with the
+  `frequenz-floss/frequenz-api-common` repository.
 
 Normally Frequenz APIs use basic types from
-[`google/api-common-protos`](https://github.com/googleapis/api-common-protos),
-so you need to make sure the proper submodule is added to your project:
+[`google/api-common-protos`](https://github.com/googleapis/api-common-protos) and
+[`frequenz-floss/frequenz-api-common`](https://github.com/frequenz-floss/frequenz-api-common),
+so you need to make sure the proper submodules are added to your project:
 
 ```sh
 mkdir submodules
-git submodule add https://github.com:googleapis/api-common-protos.git submodules/api-common-protos
-git commit -m "Add Google api-common-protos submodule" submodules/api-common-protos
+git submodule add https://github.com/googleapis/api-common-protos.git \
+        submodules/api-common-protos
+git submodule add https://github.com/frequenz-floss/frequenz-api-common.git \
+        submodules/frequenz-api-common
+git commit -m "Add api-common-protos and frequenz-api-common submodules" submodules
 ```
 
 Then you need to add this package as a build dependency and a few extra
@@ -190,6 +196,7 @@
 
 [project]
 dependencies = [
+  "frequenz-api-common == 0.2.0",
   "googleapis-common-protos == 1.56.2",
   "grpcio == 1.51.0",
 ]
@@ -222,6 +229,7 @@
 
 ```
 recursive-include submodules/api-common-protos/google *.proto
+recursive-include submodules/frequenz-api-common/proto *.proto
 ```
 
 If the defaults are not suitable for you (for example you need to use more or less
@@ -236,8 +244,8 @@
 # Glob pattern to use to find the proto files in the proto_path (default: "*.proto")
 proto_glob = "*.prt"  # Default: "*.proto"
 # List of paths to pass to the protoc compiler as include paths (default:
-# ["submodules/api-common-protos"])
-include_paths = []
+# ["submodules/api-common-protos", "submodules/frequenz-api-common/proto"])
+include_paths = ["submodules/api-common-protos"]
 # Path where to generate the Python files (default: "py")
 py_path = "generated"
 ```

src/frequenz/repo/config/setuptools/grpc_tools.py

@@ -62,7 +62,7 @@ class CompileProto(_setuptools.Command):
     DEFAULT_OPTIONS: dict[str, str] = {
         "proto_path": "proto",
         "proto_glob": "*.proto",
-        "include_paths": "submodules/api-common-protos",
+        "include_paths": "submodules/api-common-protos,submodules/frequenz-api-common/proto",
         "py_path": "py",
     }