Address cookiecutter todos

Signed-off-by: Flora <[email protected]>

Author: flora-hofmann-frequenz

.github/ISSUE_TEMPLATE/bug.yml

@@ -50,9 +50,6 @@ body:
         - Documentation (part:docs)
         - Unit, integration and performance tests (part:tests)
         - Build script, CI, dependencies, etc. (part:tooling)
-        # TODO(cookiecutter): Add other parts
-        # Please have in mind that that the part:xxx labels need to
-        # be created in the GitHub repository.
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/config.yml

@@ -5,6 +5,4 @@ blank_issues_enabled: true
 contact_links:
   - name: Ask a question ❓
     url: https://github.com/frequenz-floss/frequenz-reporting-python/discussions/new?category=support
-    # TODO(cookiecutter): Make sure the GitHub repository has a discussion category "Support"
-    # Rename the "Q&A" category to "Support" and change the emoji to 🆘 (SOS)
     about: Use this if you are not sure how to do something, have installation problems, etc.

.github/keylabeler.yml

@@ -16,6 +16,3 @@ labelMappings:
   "part:tests": "part:tests"
   "part:tooling": "part:tooling"
   "part:❓": "part:❓"
-  # TODO(cookiecutter): Add other parts
-  # Please have in mind that that the part:xxx labels need to
-  # be created in the GitHub repository.

.github/labeler.yml

@@ -6,7 +6,6 @@
 # For more details on the configuration please see:
 # https://github.com/marketplace/actions/labeler
 
-# TODO(cookiecutter): Add different parts of the source
 # For example:
 #
 # "part:module":

.github/workflows/ci.yaml

@@ -43,10 +43,6 @@ jobs:
     steps:
       - name: Setup Git
         uses: frequenz-floss/[email protected]
-        # TODO(cookiecutter): Uncomment this for projects with private dependencies
-        # with:
-        #   username: ${{ secrets.GIT_USER }}
-        #   password: ${{ secrets.GIT_PASS }}
 
       - name: Print environment (debug)
         run: env
@@ -128,10 +124,6 @@ jobs:
     steps:
       - name: Setup Git
         uses: frequenz-floss/[email protected]
-        # TODO(cookiecutter): Uncomment this for projects with private dependencies
-        # with:
-        #   username: ${{ secrets.GIT_USER }}
-        #   password: ${{ secrets.GIT_PASS }}
 
       - name: Fetch sources
         uses: actions/checkout@v4
@@ -235,10 +227,6 @@ jobs:
     steps:
       - name: Setup Git
         uses: frequenz-floss/[email protected]
-        # TODO(cookiecutter): Uncomment this for projects with private dependencies
-        # with:
-        #   username: ${{ secrets.GIT_USER }}
-        #   password: ${{ secrets.GIT_PASS }}
 
       - name: Fetch sources
         uses: actions/checkout@v4
@@ -274,10 +262,6 @@ jobs:
     steps:
       - name: Setup Git
         uses: frequenz-floss/[email protected]
-        # TODO(cookiecutter): Uncomment this for projects with private dependencies
-        # with:
-        #   username: ${{ secrets.GIT_USER }}
-        #   password: ${{ secrets.GIT_PASS }}
 
       - name: Fetch sources
         uses: actions/checkout@v4
@@ -315,10 +299,6 @@ jobs:
     steps:
       - name: Setup Git
         uses: frequenz-floss/[email protected]
-        # TODO(cookiecutter): Uncomment this for projects with private dependencies
-        # with:
-        #   username: ${{ secrets.GIT_USER }}
-        #   password: ${{ secrets.GIT_PASS }}
 
       - name: Fetch sources
         uses: actions/checkout@v4
@@ -361,10 +341,6 @@ jobs:
     steps:
       - name: Setup Git
         uses: frequenz-floss/[email protected]
-        # TODO(cookiecutter): Uncomment this for projects with private dependencies
-        # with:
-        #   username: ${{ secrets.GIT_USER }}
-        #   password: ${{ secrets.GIT_PASS }}
 
       - name: Fetch sources
         uses: actions/checkout@v4

.github/workflows/release-notes-check.yml

@@ -24,8 +24,6 @@ jobs:
         if: github.event_name == 'pull_request'
         uses: brettcannon/check-for-changed-files@871d7b8b5917a4f6f06662e2262e8ffc51dff6d1 # v1.2.1
         with:
-          # TODO(cookiecutter): Uncomment the following line for private repositories, otherwise remove it
-          # token: ${{ secrets.github_token }}
           file-pattern: "RELEASE_NOTES.md"
           prereq-pattern: "src/**"
           skip-label: "cmd:skip-release-notes"

CODEOWNERS

@@ -4,5 +4,4 @@
 # Fallback owner.
 # These are the default owners for everything in the repo, unless a later match
 # takes precedence.
-# TODO(cookiecutter): Add more specific code-owners, check if the default is correct
 * @frequenz-floss/api-reporting-team

README.md

@@ -8,8 +8,6 @@
 
 A highlevel interface for the reporting API
 
-TODO(cookiecutter): Improve the README file
-
 ## Supported Platforms
 
 The following platforms are officially supported (tested):

docs/_scripts/macros.py

@@ -74,7 +74,5 @@ def define_env(env: macros.MacrosPlugin) -> None:
     # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations
     env.variables["code_annotation_marker"] = _CODE_ANNOTATION_MARKER
 
-    # TODO(cookiecutter): Add any other macros, variables and filters here.
-
     # This hook needs to be done at the end of the `define_env` function.
     _hook_macros_plugin(env)

mkdocs.yml

@@ -8,15 +8,12 @@ site_author: "Frequenz Energy-as-a-Service GmbH"
 copyright: "Copyright © 2024 Frequenz Energy-as-a-Service GmbH"
 repo_name: "frequenz-reporting-python"
 repo_url: "https://github.com/frequenz-floss/frequenz-reporting-python"
-# TODO(cookiecutter): "main" is the GitHub repo default branch, you might want to update it
-# if the project uses a different default branch.
-edit_uri: "edit/main/docs/"
+edit_uri: "edit/v0.x.x/docs/"
 strict: true  # Treat warnings as errors
 
 # Build directories
 theme:
   name: "material"
-  # TODO(cookiecutter): You might want to change the logo, the file is located in "docs/"
   logo: _img/logo.png
   favicon: _img/logo.png
   language: en
@@ -51,7 +48,6 @@ theme:
       name: Switch to light mode
 
 extra:
-  # TODO(cookiecutter): You probably want to update the social links
   social:
   - icon: fontawesome/brands/github
     link: https://github.com/frequenz-floss
@@ -117,8 +113,6 @@ plugins:
             show_symbol_type_toc: true
             signature_crossrefs: true
           import:
-            # TODO(cookiecutter): You might want to add other external references here
-            # See https://mkdocstrings.github.io/python/usage/#import for details
             - https://docs.python.org/3/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
   # Note this plugin must be loaded after mkdocstrings to be able to use macros

pyproject.toml

@@ -14,8 +14,7 @@ name = "frequenz-reporting-python"
 description = "A highlevel interface for the reporting API"
 readme = "README.md"
 license = { text = "MIT" }
-keywords = ["frequenz", "python", "lib", "library", "frequenz-reporting", "reporting", "highlevel", "tooling", "api"]
-# TODO(cookiecutter): Remove and add more classifiers if appropriate
+keywords = ["frequenz", "python", "lib", "library", "reporting", "highlevel", "tooling", "api"]
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
@@ -26,7 +25,6 @@ classifiers = [
   "Typing :: Typed",
 ]
 requires-python = ">= 3.11, < 4"
-# TODO(cookiecutter): Remove and add more dependencies if appropriate
 dependencies = [
   "typing-extensions >= 4.5.0, < 5",
 ]
@@ -36,7 +34,6 @@ dynamic = ["version"]
 name = "Frequenz Energy-as-a-Service GmbH"
 email = "[email protected]"
 
-# TODO(cookiecutter): Remove and add more optional dependencies if appropriate
 [project.optional-dependencies]
 dev-flake8 = [
   "flake8 == 7.1.0",
@@ -55,7 +52,7 @@ dev-mkdocs = [
   "mkdocs-macros-plugin == 1.0.5",
   "mkdocs-material == 9.5.27",
   "mkdocstrings[python] == 0.25.1",
-  "mkdocstrings-python == 1.10.5",
+  "mkdocstrings-python == 1.10.8",
   "frequenz-repo-config[lib] == 0.10.0",
 ]
 dev-mypy = [
@@ -166,7 +163,7 @@ packages = ["frequenz.reporting"]
 strict = true
 
 [[tool.mypy.overrides]]
-module = ["mkdocs_macros.*", "sybil", "sybil.*"]
+module = ["mkdocs_macros.*"]
 ignore_missing_imports = true
 
 [tool.setuptools_scm]

src/frequenz/reporting/__init__.py

@@ -1,10 +1,7 @@
 # License: MIT
 # Copyright © 2024 Frequenz Energy-as-a-Service GmbH
 
-"""A highlevel interface for the reporting API.
-
-TODO(cookiecutter): Add a more descriptive module description.
-"""
+"""A highlevel interface for the reporting API."""
 
 
 # TODO(cookiecutter): Remove this function