frequenz-dispatch 1.0.2__tar.gz → 1.0.3__tar.gz

frequenz_dispatch-1.0.3/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: frequenz-dispatch
+Version: 1.0.3
+Summary: A highlevel interface for the dispatch API
+Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
+License: MIT
+Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-dispatch-python/
+Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-dispatch-python/releases
+Project-URL: Issues, https://github.com/frequenz-floss/frequenz-dispatch-python/issues
+Project-URL: Repository, https://github.com/frequenz-floss/frequenz-dispatch-python
+Project-URL: Support, https://github.com/frequenz-floss/frequenz-dispatch-python/discussions/categories/support
+Keywords: frequenz,python,actor,frequenz-dispatch,dispatch,highlevel,api
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions<5.0.0,>=4.13.0
+Requires-Dist: frequenz-sdk<1.0.0-rc2300,>=1.0.0-rc2100
+Requires-Dist: frequenz-channels<2.0.0,>=1.6.1
+Requires-Dist: frequenz-client-dispatch<2.0.0,>=0.11.3
+Requires-Dist: frequenz-client-base<0.12.0,>=0.11.0
+Provides-Extra: dev-flake8
+Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
+Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
+Requires-Dist: flake8-pyproject==1.2.4; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.8.3; extra == "dev-flake8"
+Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
+Provides-Extra: dev-formatting
+Requires-Dist: black==25.12.0; extra == "dev-formatting"
+Requires-Dist: isort==7.0.0; extra == "dev-formatting"
+Provides-Extra: dev-mkdocs
+Requires-Dist: black==25.12.0; extra == "dev-mkdocs"
+Requires-Dist: Markdown==3.10.2; extra == "dev-mkdocs"
+Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-gen-files==0.6.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.7.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==1.0.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.18.2; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.8; extra == "dev-mkdocs"
+Provides-Extra: dev-mypy
+Requires-Dist: mypy==1.19.1; extra == "dev-mypy"
+Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.10.2.20260211; extra == "dev-mypy"
+Requires-Dist: frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
+Provides-Extra: dev-noxfile
+Requires-Dist: uv==0.10.7; extra == "dev-noxfile"
+Requires-Dist: nox==2025.11.12; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.8; extra == "dev-noxfile"
+Provides-Extra: dev-pylint
+Requires-Dist: pylint==4.0.5; extra == "dev-pylint"
+Requires-Dist: frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
+Provides-Extra: dev-pytest
+Requires-Dist: pytest==9.0.2; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.8; extra == "dev-pytest"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev-pytest"
+Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
+Requires-Dist: time-machine==3.2.0; extra == "dev-pytest"
+Provides-Extra: dev
+Requires-Dist: frequenz-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
+Dynamic: license-file
+
+# 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-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
+
+The `frequenz-dispatch` library provides a high-level Python interface for
+interacting with the Frequenz Dispatch API. This library enables you to
+manage and monitor dispatch operations in microgrids, including lifecycle
+events and running status changes of dispatch operations.
+
+The main entry point is the [`Dispatcher`][dispatcher-class] class, which
+provides methods for receiving dispatch lifecycle events and running status
+updates, allowing you to build reactive applications that respond to dispatch
+state changes.
+
+## Supported Platforms
+
+The following platforms are officially supported (tested):
+
+- **Python:** 3.11, 3.13
+- **Operating System:** Ubuntu Linux 24.04
+- **Architectures:** amd64, arm64
+
+## Installation
+
+### Using pip
+
+You can install the package from PyPI:
+
+```bash
+python3 -m pip install frequenz-dispatch
+```
+
+### Using pyproject.toml
+
+Add the dependency to your `pyproject.toml` file:
+
+```toml
+[project]
+dependencies = [
+    "frequenz-dispatch >= 1.0.1, < 2",
+]
+```
+
+> [!NOTE]
+> We recommend pinning the dependency to the latest version for programs,
+> like `"frequenz-dispatch == 1.0.1"`, and specifying a version range
+> spanning one major version for libraries, like
+> `"frequenz-dispatch >= 1.0.1, < 2"`. We follow [semver](https://semver.org/).
+
+## Quick Start
+
+Here's a minimal example to get you started with lifecycle events:
+
+```python
+import asyncio
+import os
+
+from frequenz.dispatch import Created, Deleted, Dispatcher, Updated
+
+async def main() -> None:
+    url = os.getenv("DISPATCH_API_URL", "grpc://localhost:50051")
+    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "my-api-key")
+    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
+    microgrid_id = 1
+
+    async with Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        auth_key=auth_key,
+        sign_secret=sign_secret,
+    ) as dispatcher:
+        events_receiver = dispatcher.new_lifecycle_events_receiver("MY_TYPE")
+
+        async for event in events_receiver:
+            match event:
+                case Created(dispatch):
+                    print(f"Created: {dispatch}")
+                case Updated(dispatch):
+                    print(f"Updated: {dispatch}")
+                case Deleted(dispatch):
+                    print(f"Deleted: {dispatch}")
+
+asyncio.run(main())
+```
+
+The [`Dispatcher` class][dispatcher-class] provides two receiver methods:
+
+* [`new_lifecycle_events_receiver()`][lifecycle-events]: Returns a receiver
+  that sends a message whenever a Dispatch is created, updated or deleted.
+* [`new_running_state_event_receiver()`][running-status-change]: Returns a
+  receiver that sends a dispatch message whenever a dispatch is ready to be
+  executed according to the schedule or the running status of the dispatch
+  changed in a way that could potentially require the actor to start, stop or
+  reconfigure itself.
+
+### Example managing actors with dispatch events
+
+```python
+import os
+from datetime import timedelta
+from unittest.mock import MagicMock
+
+from frequenz.channels import Receiver
+from frequenz.sdk.actor import Actor
+
+from frequenz.dispatch import Dispatcher, DispatchInfo, MergeByType
+
+async def create_actor(
+    dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]
+) -> Actor:
+    return MagicMock(dispatch=dispatch, receiver=receiver)
+
+async def run() -> None:
+    url = os.getenv(
+        "DISPATCH_API_URL", "grpc://dispatch.api.example.com:50051"
+    )
+    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "my-api-key")
+    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
+
+    microgrid_id = 1
+
+    async with Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        auth_key=auth_key,
+        sign_secret=sign_secret,
+    ) as dispatcher:
+        await dispatcher.start_managing(
+            dispatch_type="EXAMPLE_TYPE",
+            actor_factory=create_actor,
+            merge_strategy=MergeByType(),
+            retry_interval=timedelta(seconds=10)
+        )
+
+        await dispatcher
+```
+
+## Documentation
+
+For complete API documentation, examples, and advanced usage patterns, see
+[the documentation][docs].
+
+[dispatcher-class]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher
+[lifecycle-events]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.new_lifecycle_events_receiver
+[running-status-change]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.new_running_state_event_receiver
+[docs]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_dispatch-1.0.3/README.md

@@ -0,0 +1,155 @@
+# 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-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
+
+The `frequenz-dispatch` library provides a high-level Python interface for
+interacting with the Frequenz Dispatch API. This library enables you to
+manage and monitor dispatch operations in microgrids, including lifecycle
+events and running status changes of dispatch operations.
+
+The main entry point is the [`Dispatcher`][dispatcher-class] class, which
+provides methods for receiving dispatch lifecycle events and running status
+updates, allowing you to build reactive applications that respond to dispatch
+state changes.
+
+## Supported Platforms
+
+The following platforms are officially supported (tested):
+
+- **Python:** 3.11, 3.13
+- **Operating System:** Ubuntu Linux 24.04
+- **Architectures:** amd64, arm64
+
+## Installation
+
+### Using pip
+
+You can install the package from PyPI:
+
+```bash
+python3 -m pip install frequenz-dispatch
+```
+
+### Using pyproject.toml
+
+Add the dependency to your `pyproject.toml` file:
+
+```toml
+[project]
+dependencies = [
+    "frequenz-dispatch >= 1.0.1, < 2",
+]
+```
+
+> [!NOTE]
+> We recommend pinning the dependency to the latest version for programs,
+> like `"frequenz-dispatch == 1.0.1"`, and specifying a version range
+> spanning one major version for libraries, like
+> `"frequenz-dispatch >= 1.0.1, < 2"`. We follow [semver](https://semver.org/).
+
+## Quick Start
+
+Here's a minimal example to get you started with lifecycle events:
+
+```python
+import asyncio
+import os
+
+from frequenz.dispatch import Created, Deleted, Dispatcher, Updated
+
+async def main() -> None:
+    url = os.getenv("DISPATCH_API_URL", "grpc://localhost:50051")
+    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "my-api-key")
+    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
+    microgrid_id = 1
+
+    async with Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        auth_key=auth_key,
+        sign_secret=sign_secret,
+    ) as dispatcher:
+        events_receiver = dispatcher.new_lifecycle_events_receiver("MY_TYPE")
+
+        async for event in events_receiver:
+            match event:
+                case Created(dispatch):
+                    print(f"Created: {dispatch}")
+                case Updated(dispatch):
+                    print(f"Updated: {dispatch}")
+                case Deleted(dispatch):
+                    print(f"Deleted: {dispatch}")
+
+asyncio.run(main())
+```
+
+The [`Dispatcher` class][dispatcher-class] provides two receiver methods:
+
+* [`new_lifecycle_events_receiver()`][lifecycle-events]: Returns a receiver
+  that sends a message whenever a Dispatch is created, updated or deleted.
+* [`new_running_state_event_receiver()`][running-status-change]: Returns a
+  receiver that sends a dispatch message whenever a dispatch is ready to be
+  executed according to the schedule or the running status of the dispatch
+  changed in a way that could potentially require the actor to start, stop or
+  reconfigure itself.
+
+### Example managing actors with dispatch events
+
+```python
+import os
+from datetime import timedelta
+from unittest.mock import MagicMock
+
+from frequenz.channels import Receiver
+from frequenz.sdk.actor import Actor
+
+from frequenz.dispatch import Dispatcher, DispatchInfo, MergeByType
+
+async def create_actor(
+    dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]
+) -> Actor:
+    return MagicMock(dispatch=dispatch, receiver=receiver)
+
+async def run() -> None:
+    url = os.getenv(
+        "DISPATCH_API_URL", "grpc://dispatch.api.example.com:50051"
+    )
+    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "my-api-key")
+    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
+
+    microgrid_id = 1
+
+    async with Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        auth_key=auth_key,
+        sign_secret=sign_secret,
+    ) as dispatcher:
+        await dispatcher.start_managing(
+            dispatch_type="EXAMPLE_TYPE",
+            actor_factory=create_actor,
+            merge_strategy=MergeByType(),
+            retry_interval=timedelta(seconds=10)
+        )
+
+        await dispatcher
+```
+
+## Documentation
+
+For complete API documentation, examples, and advanced usage patterns, see
+[the documentation][docs].
+
+[dispatcher-class]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher
+[lifecycle-events]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.new_lifecycle_events_receiver
+[running-status-change]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.new_running_state_event_receiver
+[docs]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_dispatch-1.0.3/RELEASE_NOTES.md

@@ -0,0 +1,22 @@
+# Dispatch Highlevel Interface Release Notes
+
+## Summary
+
+<!-- Here goes a general summary of what this release is about -->
+
+## Upgrading
+
+<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+
+## New Features
+
+<!-- Here goes the main new features and examples or instructions on how to use them -->
+
+## Bug Fixes
+
+<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
+
+* Fixed bugs that could cause a dispatch actor not to stop when an update
+  arrives exactly at the moment a dispatch window closes. Also fixed a
+  related issue that could cause incorrect event ordering when multiple
+  dispatches are updated concurrently.

{frequenz_dispatch-1.0.2 → frequenz_dispatch-1.0.3}/pyproject.toml

@@ -4,8 +4,8 @@
 [build-system]
 requires = [
   "setuptools == 80.9.0",
-  "setuptools_scm[toml] == 9.2.0",
-  "frequenz-repo-config[lib] == 0.13.5",
+  "setuptools_scm[toml] == 9.2.2",
+  "frequenz-repo-config[lib] == 0.13.8",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -53,48 +53,48 @@ email = "floss@frequenz.com"
 dev-flake8 = [
   "flake8 == 7.3.0",
   "flake8-docstrings == 1.7.0",
-  "flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
+  "flake8-pyproject == 1.2.4", # For reading the flake8 config from pyproject.toml
   "pydoclint == 0.8.3",
   "pydocstyle == 6.3.0",
 ]
-dev-formatting = ["black == 25.11.0", "isort == 6.0.1"]
+dev-formatting = ["black == 25.12.0", "isort == 7.0.0"]
 dev-mkdocs = [
-  "black == 25.11.0",
-  "Markdown==3.10",
+  "black == 25.12.0",
+  "Markdown==3.10.2",
   "mike == 2.1.3",
-  "mkdocs-gen-files == 0.5.0",
+  "mkdocs-gen-files == 0.6.0",
   "mkdocs-literate-nav == 0.6.2",
   "mkdocs-macros-plugin == 1.5.0",
-  "mkdocs-material == 9.7.0",
-  "mkdocstrings[python] == 0.30.1",
+  "mkdocs-material == 9.7.3",
+  "mkdocstrings[python] == 1.0.3",
   "mkdocstrings-python == 1.18.2",
-  "frequenz-repo-config[lib] == 0.13.5",
+  "frequenz-repo-config[lib] == 0.13.8",
 ]
 dev-mypy = [
-  "mypy == 1.19.0",
+  "mypy == 1.19.1",
   # This dependency introduces breaking changes in patch releases
   "grpc-stubs == 1.53.0.6",
-  "types-Markdown == 3.10.0.20251106",
+  "types-Markdown == 3.10.2.20260211",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-noxfile = [
-  "uv == 0.9.13",
+  "uv == 0.10.7",
   "nox == 2025.11.12",
-  "frequenz-repo-config[lib] == 0.13.5",
+  "frequenz-repo-config[lib] == 0.13.8",
 ]
 dev-pylint = [
-  "pylint == 3.3.8",
+  "pylint == 4.0.5",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.4.2",
-  "frequenz-repo-config[extra-lint-examples] == 0.13.5",
+  "pytest == 9.0.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.13.8",
   "pytest-mock == 3.15.1",
-  "pytest-asyncio == 1.2.0",
+  "pytest-asyncio == 1.3.0",
   "async-solipsism == 0.8",
-  "time-machine == 2.19.0",
+  "time-machine == 3.2.0",
 ]
 dev = [
   "frequenz-dispatch[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

{frequenz_dispatch-1.0.2 → frequenz_dispatch-1.0.3}/src/frequenz/dispatch/_bg_service.py

@@ -13,7 +13,7 @@ from collections.abc import Mapping
 from contextlib import closing
 from dataclasses import dataclass, field
 from datetime import datetime, timedelta, timezone
-from heapq import heappop, heappush
+from heapq import heapify, heappop, heappush
 
 import grpc.aio
 from frequenz.channels import Broadcast, Receiver, select, selected_from
@@ -228,7 +228,7 @@ class DispatchScheduler(BackgroundService):
         """Start the background service."""
         self._tasks.add(asyncio.create_task(self._run()))
 
-    async def _run(self) -> None:
+    async def _run(self) -> None:  # pylint: disable=too-many-branches
         """Run the background service."""
         _logger.info(
             "Starting dispatching background service for microgrid %s",
@@ -486,11 +486,19 @@ class DispatchScheduler(BackgroundService):
         # Dispatch was updated
         elif dispatch and old_dispatch:
             # Remove potentially existing scheduled event
-            self._remove_scheduled(old_dispatch)
+            removed = self._remove_scheduled(old_dispatch)
 
             # Check if the change requires an immediate notification
             if self._update_changed_running_state(dispatch, old_dispatch):
                 await self._send_running_state_change(dispatch)
+            elif removed is not None and removed.priority == 1 and not dispatch.started:
+                # priority == 1 means a stop event (see QueueItem.__init__).
+                # If we removed a pending stop event and the dispatch is no
+                # longer started, the update arrived exactly at the stop
+                # boundary. The timer would have delivered the stop event, but
+                # _remove_scheduled consumed it first. Send the notification
+                # here so the actor is not left running past the window end.
+                await self._send_running_state_change(dispatch)
 
             if dispatch.started:
                 self._schedule_stop(dispatch)
@@ -507,21 +515,26 @@ class DispatchScheduler(BackgroundService):
             timer.reset(interval=due_at - datetime.now(timezone.utc))
             _logger.debug("Next event scheduled at %s", self._scheduled_events[0].time)
 
-    def _remove_scheduled(self, dispatch: Dispatch) -> bool:
+    def _remove_scheduled(self, dispatch: Dispatch) -> "QueueItem | None":
         """Remove a dispatch from the scheduled events.
 
         Args:
             dispatch: The dispatch to remove.
 
         Returns:
-            True if the dispatch was found and removed, False otherwise.
+            The removed queue item, or None if not found.
         """
         for idx, item in enumerate(self._scheduled_events):
             if dispatch.id == item.dispatch.id:
                 self._scheduled_events.pop(idx)
-                return True
-
-        return False
+                # heappop() only removes the root (index 0) and does not accept
+                # an index argument, so we use list.pop(idx) instead. After
+                # removing an arbitrary element the heap property is broken and
+                # must be restored explicitly.
+                heapify(self._scheduled_events)
+                return item
+
+        return None
 
     def _schedule_start(self, dispatch: Dispatch) -> None:
         """Schedule a dispatch to start.

frequenz_dispatch-1.0.3/src/frequenz_dispatch.egg-info/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: frequenz-dispatch
+Version: 1.0.3
+Summary: A highlevel interface for the dispatch API
+Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
+License: MIT
+Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-dispatch-python/
+Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-dispatch-python/releases
+Project-URL: Issues, https://github.com/frequenz-floss/frequenz-dispatch-python/issues
+Project-URL: Repository, https://github.com/frequenz-floss/frequenz-dispatch-python
+Project-URL: Support, https://github.com/frequenz-floss/frequenz-dispatch-python/discussions/categories/support
+Keywords: frequenz,python,actor,frequenz-dispatch,dispatch,highlevel,api
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions<5.0.0,>=4.13.0
+Requires-Dist: frequenz-sdk<1.0.0-rc2300,>=1.0.0-rc2100
+Requires-Dist: frequenz-channels<2.0.0,>=1.6.1
+Requires-Dist: frequenz-client-dispatch<2.0.0,>=0.11.3
+Requires-Dist: frequenz-client-base<0.12.0,>=0.11.0
+Provides-Extra: dev-flake8
+Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
+Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
+Requires-Dist: flake8-pyproject==1.2.4; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.8.3; extra == "dev-flake8"
+Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
+Provides-Extra: dev-formatting
+Requires-Dist: black==25.12.0; extra == "dev-formatting"
+Requires-Dist: isort==7.0.0; extra == "dev-formatting"
+Provides-Extra: dev-mkdocs
+Requires-Dist: black==25.12.0; extra == "dev-mkdocs"
+Requires-Dist: Markdown==3.10.2; extra == "dev-mkdocs"
+Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-gen-files==0.6.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.7.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==1.0.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.18.2; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.8; extra == "dev-mkdocs"
+Provides-Extra: dev-mypy
+Requires-Dist: mypy==1.19.1; extra == "dev-mypy"
+Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.10.2.20260211; extra == "dev-mypy"
+Requires-Dist: frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
+Provides-Extra: dev-noxfile
+Requires-Dist: uv==0.10.7; extra == "dev-noxfile"
+Requires-Dist: nox==2025.11.12; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.8; extra == "dev-noxfile"
+Provides-Extra: dev-pylint
+Requires-Dist: pylint==4.0.5; extra == "dev-pylint"
+Requires-Dist: frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
+Provides-Extra: dev-pytest
+Requires-Dist: pytest==9.0.2; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.8; extra == "dev-pytest"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "dev-pytest"
+Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
+Requires-Dist: time-machine==3.2.0; extra == "dev-pytest"
+Provides-Extra: dev
+Requires-Dist: frequenz-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
+Dynamic: license-file
+
+# 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-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
+
+The `frequenz-dispatch` library provides a high-level Python interface for
+interacting with the Frequenz Dispatch API. This library enables you to
+manage and monitor dispatch operations in microgrids, including lifecycle
+events and running status changes of dispatch operations.
+
+The main entry point is the [`Dispatcher`][dispatcher-class] class, which
+provides methods for receiving dispatch lifecycle events and running status
+updates, allowing you to build reactive applications that respond to dispatch
+state changes.
+
+## Supported Platforms
+
+The following platforms are officially supported (tested):
+
+- **Python:** 3.11, 3.13
+- **Operating System:** Ubuntu Linux 24.04
+- **Architectures:** amd64, arm64
+
+## Installation
+
+### Using pip
+
+You can install the package from PyPI:
+
+```bash
+python3 -m pip install frequenz-dispatch
+```
+
+### Using pyproject.toml
+
+Add the dependency to your `pyproject.toml` file:
+
+```toml
+[project]
+dependencies = [
+    "frequenz-dispatch >= 1.0.1, < 2",
+]
+```
+
+> [!NOTE]
+> We recommend pinning the dependency to the latest version for programs,
+> like `"frequenz-dispatch == 1.0.1"`, and specifying a version range
+> spanning one major version for libraries, like
+> `"frequenz-dispatch >= 1.0.1, < 2"`. We follow [semver](https://semver.org/).
+
+## Quick Start
+
+Here's a minimal example to get you started with lifecycle events:
+
+```python
+import asyncio
+import os
+
+from frequenz.dispatch import Created, Deleted, Dispatcher, Updated
+
+async def main() -> None:
+    url = os.getenv("DISPATCH_API_URL", "grpc://localhost:50051")
+    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "my-api-key")
+    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
+    microgrid_id = 1
+
+    async with Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        auth_key=auth_key,
+        sign_secret=sign_secret,
+    ) as dispatcher:
+        events_receiver = dispatcher.new_lifecycle_events_receiver("MY_TYPE")
+
+        async for event in events_receiver:
+            match event:
+                case Created(dispatch):
+                    print(f"Created: {dispatch}")
+                case Updated(dispatch):
+                    print(f"Updated: {dispatch}")
+                case Deleted(dispatch):
+                    print(f"Deleted: {dispatch}")
+
+asyncio.run(main())
+```
+
+The [`Dispatcher` class][dispatcher-class] provides two receiver methods:
+
+* [`new_lifecycle_events_receiver()`][lifecycle-events]: Returns a receiver
+  that sends a message whenever a Dispatch is created, updated or deleted.
+* [`new_running_state_event_receiver()`][running-status-change]: Returns a
+  receiver that sends a dispatch message whenever a dispatch is ready to be
+  executed according to the schedule or the running status of the dispatch
+  changed in a way that could potentially require the actor to start, stop or
+  reconfigure itself.
+
+### Example managing actors with dispatch events
+
+```python
+import os
+from datetime import timedelta
+from unittest.mock import MagicMock
+
+from frequenz.channels import Receiver
+from frequenz.sdk.actor import Actor
+
+from frequenz.dispatch import Dispatcher, DispatchInfo, MergeByType
+
+async def create_actor(
+    dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]
+) -> Actor:
+    return MagicMock(dispatch=dispatch, receiver=receiver)
+
+async def run() -> None:
+    url = os.getenv(
+        "DISPATCH_API_URL", "grpc://dispatch.api.example.com:50051"
+    )
+    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "my-api-key")
+    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
+
+    microgrid_id = 1
+
+    async with Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        auth_key=auth_key,
+        sign_secret=sign_secret,
+    ) as dispatcher:
+        await dispatcher.start_managing(
+            dispatch_type="EXAMPLE_TYPE",
+            actor_factory=create_actor,
+            merge_strategy=MergeByType(),
+            retry_interval=timedelta(seconds=10)
+        )
+
+        await dispatcher
+```
+
+## Documentation
+
+For complete API documentation, examples, and advanced usage patterns, see
+[the documentation][docs].
+
+[dispatcher-class]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher
+[lifecycle-events]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.new_lifecycle_events_receiver
+[running-status-change]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.new_running_state_event_receiver
+[docs]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/
+
+## Contributing
+
+If you want to know how to build this project and contribute to it, please
+check out the [Contributing Guide](CONTRIBUTING.md).

{frequenz_dispatch-1.0.2 → frequenz_dispatch-1.0.3}/src/frequenz_dispatch.egg-info/requires.txt

@@ -10,45 +10,45 @@ frequenz-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-
 [dev-flake8]
 flake8==7.3.0
 flake8-docstrings==1.7.0
-flake8-pyproject==1.2.3
+flake8-pyproject==1.2.4
 pydoclint==0.8.3
 pydocstyle==6.3.0
 
 [dev-formatting]
-black==25.11.0
-isort==6.0.1
+black==25.12.0
+isort==7.0.0
 
 [dev-mkdocs]
-black==25.11.0
-Markdown==3.10
+black==25.12.0
+Markdown==3.10.2
 mike==2.1.3
-mkdocs-gen-files==0.5.0
+mkdocs-gen-files==0.6.0
 mkdocs-literate-nav==0.6.2
 mkdocs-macros-plugin==1.5.0
-mkdocs-material==9.7.0
-mkdocstrings[python]==0.30.1
+mkdocs-material==9.7.3
+mkdocstrings[python]==1.0.3
 mkdocstrings-python==1.18.2
-frequenz-repo-config[lib]==0.13.5
+frequenz-repo-config[lib]==0.13.8
 
 [dev-mypy]
-mypy==1.19.0
+mypy==1.19.1
 grpc-stubs==1.53.0.6
-types-Markdown==3.10.0.20251106
+types-Markdown==3.10.2.20260211
 frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
-uv==0.9.13
+uv==0.10.7
 nox==2025.11.12
-frequenz-repo-config[lib]==0.13.5
+frequenz-repo-config[lib]==0.13.8
 
 [dev-pylint]
-pylint==3.3.8
+pylint==4.0.5
 frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
-pytest==8.4.2
-frequenz-repo-config[extra-lint-examples]==0.13.5
+pytest==9.0.2
+frequenz-repo-config[extra-lint-examples]==0.13.8
 pytest-mock==3.15.1
-pytest-asyncio==1.2.0
+pytest-asyncio==1.3.0
 async-solipsism==0.8
-time-machine==2.19.0
+time-machine==3.2.0

frequenz_dispatch-1.0.2/PKG-INFO

@@ -1,136 +0,0 @@
-Metadata-Version: 2.4
-Name: frequenz-dispatch
-Version: 1.0.2
-Summary: A highlevel interface for the dispatch API
-Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
-License: MIT
-Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-dispatch-python/
-Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-dispatch-python/releases
-Project-URL: Issues, https://github.com/frequenz-floss/frequenz-dispatch-python/issues
-Project-URL: Repository, https://github.com/frequenz-floss/frequenz-dispatch-python
-Project-URL: Support, https://github.com/frequenz-floss/frequenz-dispatch-python/discussions/categories/support
-Keywords: frequenz,python,actor,frequenz-dispatch,dispatch,highlevel,api
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Typing :: Typed
-Requires-Python: <4,>=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typing-extensions<5.0.0,>=4.13.0
-Requires-Dist: frequenz-sdk<1.0.0-rc2300,>=1.0.0-rc2100
-Requires-Dist: frequenz-channels<2.0.0,>=1.6.1
-Requires-Dist: frequenz-client-dispatch<2.0.0,>=0.11.3
-Requires-Dist: frequenz-client-base<0.12.0,>=0.11.0
-Provides-Extra: dev-flake8
-Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
-Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
-Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
-Requires-Dist: pydoclint==0.8.3; extra == "dev-flake8"
-Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
-Provides-Extra: dev-formatting
-Requires-Dist: black==25.11.0; extra == "dev-formatting"
-Requires-Dist: isort==6.0.1; extra == "dev-formatting"
-Provides-Extra: dev-mkdocs
-Requires-Dist: black==25.11.0; extra == "dev-mkdocs"
-Requires-Dist: Markdown==3.10; extra == "dev-mkdocs"
-Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-material==9.7.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings-python==1.18.2; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-mkdocs"
-Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.19.0; extra == "dev-mypy"
-Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
-Requires-Dist: types-Markdown==3.10.0.20251106; extra == "dev-mypy"
-Requires-Dist: frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
-Provides-Extra: dev-noxfile
-Requires-Dist: uv==0.9.13; extra == "dev-noxfile"
-Requires-Dist: nox==2025.11.12; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-noxfile"
-Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.8; extra == "dev-pylint"
-Requires-Dist: frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
-Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.4.2; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
-Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
-Requires-Dist: pytest-asyncio==1.2.0; extra == "dev-pytest"
-Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
-Requires-Dist: time-machine==2.19.0; extra == "dev-pytest"
-Provides-Extra: dev
-Requires-Dist: frequenz-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
-Dynamic: license-file
-
-# 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-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.
-
-See [the documentation](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch) for more information.
-
-## Usage
-
-The [`Dispatcher` class](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher), the main entry point for the API, provides two channels:
-
-* [Lifecycle events](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.lifecycle_events): A channel that sends a message whenever a [Dispatch][frequenz.dispatch.Dispatch] is created, updated or deleted.
-* [Running status change](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.running_status_change): Sends a dispatch message whenever a dispatch is ready to be executed according to the schedule or the running status of the dispatch changed in a way that could potentially require the actor to start, stop or reconfigure itself.
-
-### Example using the running status change channel
-
-```python
-import os
-from unittest.mock import MagicMock
-from datetime import timedelta
-
-from frequenz.dispatch import Dispatcher, DispatchInfo, MergeByType
-
-async def create_actor(dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]) -> Actor:
-    return MagicMock(dispatch=dispatch, receiver=receiver)
-
-async def run():
-    url = os.getenv("DISPATCH_API_URL", "grpc://dispatch.url.goes.here.example.com")
-    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "some-key")
-    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
-
-    microgrid_id = 1
-
-    async with Dispatcher(
-        microgrid_id=microgrid_id,
-        server_url=url,
-        auth_key=auth_key,
-        sign_secret=sign_secret,
-    ) as dispatcher:
-        await dispatcher.start_managing(
-            dispatch_type="EXAMPLE_TYPE",
-            actor_factory=create_actor,
-            merge_strategy=MergeByType(),
-            retry_interval=timedelta(seconds=10)
-        )
-
-        await dispatcher
-```
-
-## Supported Platforms
-
-The following platforms are officially supported (tested):
-
-- **Python:** 3.11
-- **Operating System:** Ubuntu Linux 20.04
-- **Architectures:** amd64, arm64
-
-## Contributing
-
-If you want to know how to build this project and contribute to it, please
-check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_dispatch-1.0.2/README.md

@@ -1,66 +0,0 @@
-# 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-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.
-
-See [the documentation](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch) for more information.
-
-## Usage
-
-The [`Dispatcher` class](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher), the main entry point for the API, provides two channels:
-
-* [Lifecycle events](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.lifecycle_events): A channel that sends a message whenever a [Dispatch][frequenz.dispatch.Dispatch] is created, updated or deleted.
-* [Running status change](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.running_status_change): Sends a dispatch message whenever a dispatch is ready to be executed according to the schedule or the running status of the dispatch changed in a way that could potentially require the actor to start, stop or reconfigure itself.
-
-### Example using the running status change channel
-
-```python
-import os
-from unittest.mock import MagicMock
-from datetime import timedelta
-
-from frequenz.dispatch import Dispatcher, DispatchInfo, MergeByType
-
-async def create_actor(dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]) -> Actor:
-    return MagicMock(dispatch=dispatch, receiver=receiver)
-
-async def run():
-    url = os.getenv("DISPATCH_API_URL", "grpc://dispatch.url.goes.here.example.com")
-    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "some-key")
-    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
-
-    microgrid_id = 1
-
-    async with Dispatcher(
-        microgrid_id=microgrid_id,
-        server_url=url,
-        auth_key=auth_key,
-        sign_secret=sign_secret,
-    ) as dispatcher:
-        await dispatcher.start_managing(
-            dispatch_type="EXAMPLE_TYPE",
-            actor_factory=create_actor,
-            merge_strategy=MergeByType(),
-            retry_interval=timedelta(seconds=10)
-        )
-
-        await dispatcher
-```
-
-## Supported Platforms
-
-The following platforms are officially supported (tested):
-
-- **Python:** 3.11
-- **Operating System:** Ubuntu Linux 20.04
-- **Architectures:** amd64, arm64
-
-## Contributing
-
-If you want to know how to build this project and contribute to it, please
-check out the [Contributing Guide](CONTRIBUTING.md).

frequenz_dispatch-1.0.2/RELEASE_NOTES.md

@@ -1,5 +0,0 @@
-# Dispatch Highlevel Interface Release Notes
-
-## Summary
-
-This release just updates some dependencies to allow compatibility with newer versions.

frequenz_dispatch-1.0.2/src/frequenz_dispatch.egg-info/PKG-INFO

@@ -1,136 +0,0 @@
-Metadata-Version: 2.4
-Name: frequenz-dispatch
-Version: 1.0.2
-Summary: A highlevel interface for the dispatch API
-Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
-License: MIT
-Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-dispatch-python/
-Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-dispatch-python/releases
-Project-URL: Issues, https://github.com/frequenz-floss/frequenz-dispatch-python/issues
-Project-URL: Repository, https://github.com/frequenz-floss/frequenz-dispatch-python
-Project-URL: Support, https://github.com/frequenz-floss/frequenz-dispatch-python/discussions/categories/support
-Keywords: frequenz,python,actor,frequenz-dispatch,dispatch,highlevel,api
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Typing :: Typed
-Requires-Python: <4,>=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typing-extensions<5.0.0,>=4.13.0
-Requires-Dist: frequenz-sdk<1.0.0-rc2300,>=1.0.0-rc2100
-Requires-Dist: frequenz-channels<2.0.0,>=1.6.1
-Requires-Dist: frequenz-client-dispatch<2.0.0,>=0.11.3
-Requires-Dist: frequenz-client-base<0.12.0,>=0.11.0
-Provides-Extra: dev-flake8
-Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
-Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
-Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
-Requires-Dist: pydoclint==0.8.3; extra == "dev-flake8"
-Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
-Provides-Extra: dev-formatting
-Requires-Dist: black==25.11.0; extra == "dev-formatting"
-Requires-Dist: isort==6.0.1; extra == "dev-formatting"
-Provides-Extra: dev-mkdocs
-Requires-Dist: black==25.11.0; extra == "dev-mkdocs"
-Requires-Dist: Markdown==3.10; extra == "dev-mkdocs"
-Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-macros-plugin==1.5.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-material==9.7.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings-python==1.18.2; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-mkdocs"
-Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.19.0; extra == "dev-mypy"
-Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
-Requires-Dist: types-Markdown==3.10.0.20251106; extra == "dev-mypy"
-Requires-Dist: frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
-Provides-Extra: dev-noxfile
-Requires-Dist: uv==0.9.13; extra == "dev-noxfile"
-Requires-Dist: nox==2025.11.12; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-noxfile"
-Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.8; extra == "dev-pylint"
-Requires-Dist: frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
-Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.4.2; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
-Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
-Requires-Dist: pytest-asyncio==1.2.0; extra == "dev-pytest"
-Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
-Requires-Dist: time-machine==2.19.0; extra == "dev-pytest"
-Provides-Extra: dev
-Requires-Dist: frequenz-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
-Dynamic: license-file
-
-# 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-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.
-
-See [the documentation](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch) for more information.
-
-## Usage
-
-The [`Dispatcher` class](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher), the main entry point for the API, provides two channels:
-
-* [Lifecycle events](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.lifecycle_events): A channel that sends a message whenever a [Dispatch][frequenz.dispatch.Dispatch] is created, updated or deleted.
-* [Running status change](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.running_status_change): Sends a dispatch message whenever a dispatch is ready to be executed according to the schedule or the running status of the dispatch changed in a way that could potentially require the actor to start, stop or reconfigure itself.
-
-### Example using the running status change channel
-
-```python
-import os
-from unittest.mock import MagicMock
-from datetime import timedelta
-
-from frequenz.dispatch import Dispatcher, DispatchInfo, MergeByType
-
-async def create_actor(dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]) -> Actor:
-    return MagicMock(dispatch=dispatch, receiver=receiver)
-
-async def run():
-    url = os.getenv("DISPATCH_API_URL", "grpc://dispatch.url.goes.here.example.com")
-    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "some-key")
-    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
-
-    microgrid_id = 1
-
-    async with Dispatcher(
-        microgrid_id=microgrid_id,
-        server_url=url,
-        auth_key=auth_key,
-        sign_secret=sign_secret,
-    ) as dispatcher:
-        await dispatcher.start_managing(
-            dispatch_type="EXAMPLE_TYPE",
-            actor_factory=create_actor,
-            merge_strategy=MergeByType(),
-            retry_interval=timedelta(seconds=10)
-        )
-
-        await dispatcher
-```
-
-## Supported Platforms
-
-The following platforms are officially supported (tested):
-
-- **Python:** 3.11
-- **Operating System:** Ubuntu Linux 20.04
-- **Architectures:** amd64, arm64
-
-## Contributing
-
-If you want to know how to build this project and contribute to it, please
-check out the [Contributing Guide](CONTRIBUTING.md).