Fix cookiecutter TODOS

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

.cookiecutter-replay.json

@@ -10,8 +10,8 @@
     "license": "MIT",
     "author_name": "Frequenz Energy-as-a-Service GmbH",
     "author_email": "[email protected]",
-    "python_package": "frequenz.actor.dispatch",
-    "pypi_package_name": "frequenz-actor-dispatch",
+    "python_package": "frequenz.dispatch",
+    "pypi_package_name": "frequenz-dispatch",
     "github_repo_name": "frequenz-dispatch-python",
     "default_codeowners": "@frequenz-floss/api-dispatch-team",
     "_template": "gh:frequenz-floss/frequenz-repo-config-python",

.github/ISSUE_TEMPLATE/bug.yml

@@ -50,9 +50,7 @@ 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.
+        - Actor (part:actor)
     validations:
       required: true
   - type: textarea

.github/keylabeler.yml

@@ -16,6 +16,4 @@ 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.
+  "part:actor": "part:actor"

.github/labeler.yml

@@ -61,3 +61,8 @@
       - CODEOWNERS
       - MANIFEST.in
       - noxfile.py
+
+"part:actor":
+  - changed-files:
+    - any-glob-to-any-file:
+      - "src/frequenz/dispatch/actor/**"

.github/workflows/ci.yaml

@@ -50,7 +50,7 @@ jobs:
           submodules: true
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
           cache: 'pip'
@@ -133,7 +133,7 @@ jobs:
       # https://github.com/docker/build-push-action/issues/252
       # https://github.com/moby/buildkit/issues/1896
       - name: Cache container layers
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-buildx-nox-${{ matrix.arch }}-${{ matrix.os }}-${{ matrix.python }}
@@ -158,7 +158,7 @@ jobs:
 
       # Cache pip downloads
       - name: Cache pip downloads
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: /tmp/pip-cache
           key: nox-${{ matrix.nox-session }}-${{ matrix.arch }}-${{ matrix.os }}-${{ matrix.python }}-${{ hashFiles('**/pyproject.toml') }}
@@ -217,7 +217,7 @@ jobs:
           submodules: true
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
           cache: 'pip'
@@ -232,7 +232,7 @@ jobs:
         run: python -m build
 
       - name: Upload distribution files
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: dist-packages
           path: dist/
@@ -246,7 +246,7 @@ jobs:
       - name: Fetch sources
         uses: actions/checkout@v4
       - name: Download package
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: dist-packages
           path: dist
@@ -277,7 +277,7 @@ jobs:
         uses: frequenz-floss/setup-git-user@v2
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
           cache: 'pip'
@@ -296,7 +296,7 @@ jobs:
           mike set-default $MIKE_VERSION
 
       - name: Upload site
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: docs-site
           path: site/
@@ -319,7 +319,7 @@ jobs:
         uses: frequenz-floss/setup-git-user@v2
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
           cache: 'pip'
@@ -386,7 +386,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Download distribution files
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: dist-packages
           path: dist
@@ -432,7 +432,7 @@ jobs:
       id-token: write
     steps:
       - name: Download distribution files
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: dist-packages
           path: dist

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

@@ -22,8 +22,6 @@ jobs:
         if: github.event_name == 'pull_request'
         uses: brettcannon/check-for-changed-files@4170644959a21843b31f1181f2a1761d65ef4791 # v1.2.0
         with:
-          # TODO(cookiecutter): Uncomment the following line for private repositories, otherwise remove it and 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-dispatch-team

CONTRIBUTING.md

@@ -141,7 +141,7 @@ These are the steps to create a new release:
    a [GitHub
    Release](https://github.com/frequenz-floss/frequenz-dispatch-python/releases),
    and upload a new package to
-   [PyPI](https://pypi.org/project/frequenz-actor-dispatch/)
+   [PyPI](https://pypi.org/project/frequenz-dispatch/)
    automatically.
 
 6. Once this is done, reset the `RELEASE_NOTES.md` with the template:

README.md

@@ -1,14 +1,37 @@
 # Dispatch Highlevel Interface
 
 [![Build Status](https://github.com/frequenz-floss/frequenz-dispatch-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/frequenz-floss/frequenz-dispatch-python/actions/workflows/ci.yaml)
-[![PyPI Package](https://img.shields.io/pypi/v/frequenz-actor-dispatch)](https://pypi.org/project/frequenz-actor-dispatch/)
+[![PyPI Package](https://img.shields.io/pypi/v/frequenz-dispatch)](https://pypi.org/project/frequenz-dispatch/)
 [![Docs](https://img.shields.io/badge/docs-latest-informational)](https://frequenz-floss.github.io/frequenz-dispatch-python/)
 
 ## Introduction
 
-A highlevel interface for the dispatch API
-
-TODO(cookiecutter): Improve the README file
+A highlevel interface for the dispatch API.
+The interface is made of the dispatch actor which should run once per microgrid.
+It provides two channels for clients:
+- "new_dispatches" for newly created dispatches
+- "ready_dispatches" for dispatches that are ready to be executed
+
+## Example Usage
+
+```python
+async def run():
+    # dispatch helper sends out dispatches when they are due
+    dispatch_arrived = dispatch_helper.new_dispatches().new_receiver()
+    dispatch_ready = dispatch_helper.ready_dispatches().new_receiver()
+
+    async for selected in select(dispatch_ready, dispatch_arrived):
+        if selected_from(selected, dispatch_arrived):
+            dispatch = selected.value
+            match dispatch.type:
+                case DISPATCH_TYPE_BATTERY_CHARGE:
+                    battery_pool = microgrid.battery_pool(dispatch.battery_set, task_id)
+                    battery_pool.set_charge(dispatch.power)
+            ...
+        if selected_from(selected, dispatch_ready):
+            dispatch = selected.value
+            log.info("New dispatch arrived %s", dispatch)
+```
 
 ## Supported Platforms
 

docs/_scripts/macros.py

@@ -77,7 +77,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-dispatch-python"
 repo_url: "https://github.com/frequenz-floss/frequenz-dispatch-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
@@ -116,12 +112,12 @@ plugins:
             show_source: 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://frequenz-floss.github.io/frequenz-channels-python/v0.16/objects.inv
             - https://frequenz-floss.github.io/frequenz-sdk-python/v0.25/objects.inv
             - https://typing-extensions.readthedocs.io/en/stable/objects.inv
+            - https://frequenz-floss.github.io/frequenz-client-dispatch-python/v0.1/objects.inv
   # Note this plugin must be loaded after mkdocstrings to be able to use macros
   # inside docstrings. See the comment in `docs/_scripts/macros.py` for more
   # details

pyproject.toml

@@ -5,12 +5,12 @@
 requires = [
   "setuptools == 68.1.0",
   "setuptools_scm[toml] == 7.1.0",
-  "frequenz-repo-config[actor] == 0.9.0",
+  "frequenz-repo-config[lib] == 0.9.0",
 ]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "frequenz-actor-dispatch"
+name = "frequenz-dispatch"
 description = "A highlevel interface for the dispatch API"
 readme = "README.md"
 license = { text = "MIT" }
@@ -59,22 +59,22 @@ dev-mkdocs = [
   "mkdocs-macros-plugin == 1.0.4",
   "mkdocs-material == 9.3.1",
   "mkdocstrings[python] == 0.23.0",
-  "frequenz-repo-config[actor] == 0.9.0",
+  "frequenz-repo-config[lib] == 0.9.0",
 ]
 dev-mypy = [
   "mypy == 1.5.1",
   "types-Markdown == 3.4.2.10",
   # For checking the noxfile, docs/ script, and tests
-  "frequenz-actor-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
+  "frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-noxfile = [
   "nox == 2023.4.22",
-  "frequenz-repo-config[actor] == 0.9.0",
+  "frequenz-repo-config[lib] == 0.9.0",
 ]
 dev-pylint = [
   "pylint == 3.0.2",
   # For checking the noxfile, docs/ script, and tests
-  "frequenz-actor-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
+  "frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
   "pytest == 8.0.0",
@@ -84,7 +84,7 @@ dev-pytest = [
   "async-solipsism == 0.5",
 ]
 dev = [
-  "frequenz-actor-dispatch[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
+  "frequenz-dispatch[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
 ]
 
 [project.urls]
@@ -159,11 +159,11 @@ namespace_packages = true
 # used but getting the original ignored error when removing the type: ignore.
 # See for example: https://github.com/python/mypy/issues/2960
 #no_incremental = true
-packages = ["frequenz.actor.dispatch"]
+packages = ["frequenz.dispatch"]
 strict = true
 
 [[tool.mypy.overrides]]
-module = ["mkdocs_macros.*", "sybil", "sybil.*"]
+module = ["mkdocs_macros.*"]
 ignore_missing_imports = true
 
 [tool.setuptools_scm]