frequenz-dispatch 0.1.0__tar.gz → 0.2.0__tar.gz

{frequenz-dispatch-0.1.0/src/frequenz_dispatch.egg-info → frequenz-dispatch-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-dispatch
-Version: 0.1.0
+Version: 0.2.0
 Summary: A highlevel interface for the dispatch API
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT

frequenz-dispatch-0.2.0/RELEASE_NOTES.md

@@ -0,0 +1,5 @@
+# Dispatch Highlevel Interface Release Notes
+
+## Upgrading
+
+* An API key for authorization must now be passed to the client.

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.2.0}/pyproject.toml

@@ -35,16 +35,13 @@ classifiers = [
 requires-python = ">= 3.11, < 4"
 dependencies = [
   "python-dateutil >= 2.8.2, < 3.0",
-  "typing-extensions == 4.11.0",
+  "typing-extensions >= 4.11.0, < 5.0.0",
   # Make sure to update the version for cross-referencing also in the
   # mkdocs.yml file when changing the version here (look for the config key
   # plugins.mkdocstrings.handlers.python.import)
-  "frequenz-sdk == v1.0.0-rc6",
-  "frequenz-channels == 1.0.0",
-  "frequenz-api-dispatch >= 0.13.0, < 0.14",
-  "frequenz-client-dispatch == 0.2.0",
-  "frequenz-client-base >= 0.3.0, < 0.4.0",
-  "frequenz-client-common >= 0.1.0, < 0.2.0",
+  "frequenz-sdk == 1.0.0rc601",
+  "frequenz-channels >= 1.0.1, < 2.0.0",
+  "frequenz-client-dispatch >= 0.5.0, < 0.6.0",
 ]
 dynamic = ["version"]
 
@@ -54,48 +51,48 @@ email = "floss@frequenz.com"
 
 [project.optional-dependencies]
 dev-flake8 = [
-  "flake8 == 7.0.0",
+  "flake8 == 7.1.0",
   "flake8-docstrings == 1.7.0",
   "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
-  "pydoclint == 0.4.1",
+  "pydoclint == 0.5.3",
   "pydocstyle == 6.3.0",
 ]
 dev-formatting = ["black == 24.4.2", "isort == 5.13.2"]
 dev-mkdocs = [
   "black == 24.4.2",
   "Markdown==3.6",
-  "mike == 2.1.0",
+  "mike == 2.1.2",
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.1",
   "mkdocs-macros-plugin == 1.0.5",
-  "mkdocs-material == 9.5.20",
-  "mkdocstrings[python] == 0.25.0",
+  "mkdocs-material == 9.5.27",
+  "mkdocstrings[python] == 0.25.1",
   "frequenz-repo-config[lib] == 0.9.2",
 ]
 dev-mypy = [
-  "mypy == 1.10.0",
+  "mypy == 1.10.1",
   "types-Markdown == 3.6.0.20240316",
   "types-python-dateutil==2.9.0.20240316",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-noxfile = [
-  "uv == 0.1.39",
+  "uv == 0.2.18",
   "nox == 2024.4.15",
   "frequenz-repo-config[lib] == 0.9.2",
 ]
 dev-pylint = [
-  "pylint == 3.1.0",
+  "pylint == 3.2.5",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.2.0",
+  "pytest == 8.2.2",
   "frequenz-repo-config[extra-lint-examples] == 0.9.2",
   "pytest-mock == 3.14.0",
-  "pytest-asyncio == 0.23.6",
+  "pytest-asyncio == 0.23.7",
   "async-solipsism == 0.6",
-  "time-machine == 2.14.1",
+  "time-machine == 2.14.2",
 ]
 dev = [
   "frequenz-dispatch[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.2.0}/src/frequenz/dispatch/_dispatcher.py

@@ -62,11 +62,19 @@ class Dispatcher:
         async def run():
             host = os.getenv("DISPATCH_API_HOST", "localhost")
             port = os.getenv("DISPATCH_API_PORT", "50051")
+            key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
             service_address = f"{host}:{port}"
-            grpc_channel = grpc.aio.insecure_channel(service_address)
-            microgrid_id = 1
-            dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
+            grpc_channel = grpc.aio.secure_channel(
+                service_address,
+                credentials=grpc.ssl_channel_credentials()
+            )
+            dispatcher = Dispatcher(
+                microgrid_id=1,
+                grpc_channel=grpc_channel,
+                svc_addr=service_address,
+                key=key
+            )
             await dispatcher.start()
 
             actor = MagicMock() # replace with your actor
@@ -110,12 +118,20 @@ class Dispatcher:
         async def run():
             host = os.getenv("DISPATCH_API_HOST", "localhost")
             port = os.getenv("DISPATCH_API_PORT", "50051")
+            key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
             service_address = f"{host}:{port}"
-            grpc_channel = grpc.aio.insecure_channel(service_address)
-            microgrid_id = 1
-            dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
-            dispatcher.start()  # this will start the actor
+            grpc_channel = grpc.aio.secure_channel(
+                service_address,
+                credentials=grpc.ssl_channel_credentials()
+            )
+            dispatcher = Dispatcher(
+                microgrid_id=1,
+                grpc_channel=grpc_channel,
+                svc_addr=service_address,
+                key=key
+            )
+            await dispatcher.start()  # this will start the actor
 
             events_receiver = dispatcher.lifecycle_events.new_receiver()
 
@@ -146,17 +162,27 @@ class Dispatcher:
         async def run():
             host = os.getenv("DISPATCH_API_HOST", "localhost")
             port = os.getenv("DISPATCH_API_PORT", "50051")
+            key  = os.getenv("DISPATCH_API_KEY", "some-key")
 
-            service_address = f"{host}:{port}"
-            grpc_channel = grpc.aio.insecure_channel(service_address)
             microgrid_id = 1
-            dispatcher = Dispatcher(microgrid_id, grpc_channel, service_address)
+
+            service_address = f"{host}:{port}"
+            grpc_channel = grpc.aio.secure_channel(
+                service_address,
+                credentials=grpc.ssl_channel_credentials()
+            )
+            dispatcher = Dispatcher(
+                microgrid_id=microgrid_id,
+                grpc_channel=grpc_channel,
+                svc_addr=service_address,
+                key=key
+            )
             await dispatcher.start()  # this will start the actor
 
             # Create a new dispatch
             new_dispatch = await dispatcher.client.create(
                 microgrid_id=microgrid_id,
-                _type="ECHO_FREQUENCY",  # replace with your own type
+                type="ECHO_FREQUENCY",  # replace with your own type
                 start_time=datetime.now(tz=timezone.utc) + timedelta(minutes=10),
                 duration=timedelta(minutes=5),
                 selector=ComponentCategory.INVERTER,
@@ -165,17 +191,26 @@ class Dispatcher:
 
             # Modify the dispatch
             await dispatcher.client.update(
-                dispatch_id=new_dispatch.id, new_fields={"duration": timedelta(minutes=10)}
+                microgrid_id=microgrid_id,
+                dispatch_id=new_dispatch.id,
+                new_fields={"duration": timedelta(minutes=10)}
             )
 
             # Validate the modification
-            modified_dispatch = await dispatcher.client.get(new_dispatch.id)
+            modified_dispatch = await dispatcher.client.get(
+                microgrid_id=microgrid_id, dispatch_id=new_dispatch.id
+            )
             assert modified_dispatch.duration == timedelta(minutes=10)
         ```
     """
 
     def __init__(
-        self, microgrid_id: int, grpc_channel: grpc.aio.Channel, svc_addr: str
+        self,
+        *,
+        microgrid_id: int,
+        grpc_channel: grpc.aio.Channel,
+        svc_addr: str,
+        key: str,
     ):
         """Initialize the dispatcher.
 
@@ -183,12 +218,13 @@ class Dispatcher:
             microgrid_id: The microgrid id.
             grpc_channel: The gRPC channel.
             svc_addr: The service address.
+            key: The key to access the service.
         """
         self._running_state_channel = Broadcast[Dispatch](name="running_state_change")
         self._lifecycle_events_channel = Broadcast[DispatchEvent](
             name="lifecycle_events"
         )
-        self._client = Client(grpc_channel, svc_addr)
+        self._client = Client(grpc_channel=grpc_channel, svc_addr=svc_addr, key=key)
         self._actor = DispatchingActor(
             microgrid_id,
             self._client,

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.2.0/src/frequenz_dispatch.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: frequenz-dispatch
-Version: 0.1.0
+Version: 0.2.0
 Summary: A highlevel interface for the dispatch API
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT

{frequenz-dispatch-0.1.0 → frequenz-dispatch-0.2.0}/src/frequenz_dispatch.egg-info/requires.txt

@@ -1,20 +1,17 @@
 python-dateutil<3.0,>=2.8.2
-typing-extensions==4.11.0
-frequenz-sdk==v1.0.0-rc6
-frequenz-channels==1.0.0
-frequenz-api-dispatch<0.14,>=0.13.0
-frequenz-client-dispatch==0.2.0
-frequenz-client-base<0.4.0,>=0.3.0
-frequenz-client-common<0.2.0,>=0.1.0
+typing-extensions<5.0.0,>=4.11.0
+frequenz-sdk==1.0.0rc601
+frequenz-channels<2.0.0,>=1.0.1
+frequenz-client-dispatch<0.6.0,>=0.5.0
 
 [dev]
 frequenz-dispatch[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
 
 [dev-flake8]
-flake8==7.0.0
+flake8==7.1.0
 flake8-docstrings==1.7.0
 flake8-pyproject==1.2.3
-pydoclint==0.4.1
+pydoclint==0.5.3
 pydocstyle==6.3.0
 
 [dev-formatting]
@@ -24,33 +21,33 @@ isort==5.13.2
 [dev-mkdocs]
 black==24.4.2
 Markdown==3.6
-mike==2.1.0
+mike==2.1.2
 mkdocs-gen-files==0.5.0
 mkdocs-literate-nav==0.6.1
 mkdocs-macros-plugin==1.0.5
-mkdocs-material==9.5.20
-mkdocstrings[python]==0.25.0
+mkdocs-material==9.5.27
+mkdocstrings[python]==0.25.1
 frequenz-repo-config[lib]==0.9.2
 
 [dev-mypy]
-mypy==1.10.0
+mypy==1.10.1
 types-Markdown==3.6.0.20240316
 types-python-dateutil==2.9.0.20240316
 frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
-uv==0.1.39
+uv==0.2.18
 nox==2024.4.15
 frequenz-repo-config[lib]==0.9.2
 
 [dev-pylint]
-pylint==3.1.0
+pylint==3.2.5
 frequenz-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
-pytest==8.2.0
+pytest==8.2.2
 frequenz-repo-config[extra-lint-examples]==0.9.2
 pytest-mock==3.14.0
-pytest-asyncio==0.23.6
+pytest-asyncio==0.23.7
 async-solipsism==0.6
-time-machine==2.14.1
+time-machine==2.14.2

frequenz-dispatch-0.1.0/RELEASE_NOTES.md

@@ -1,14 +0,0 @@
-# Dispatch Highlevel Interface Release Notes
-
-## Summary
-
-This is the first release of the highlevel dispatch interface!
-
-## Upgrading
-
-* `Dispatcher.ready_to_execute()` was renamed to `Dispatcher.running_status_change()`
-
-## New Features
-
-* Introduced new class `Dispatch` (based on the client class) that contains useful functions and extended information about the received dispatch.
-* `Dispatcher.client` was added to provide an easy access to the client for updating, deleting and creating dispatches