hexkit 2.1.1__tar.gz → 3.0.0__tar.gz

{hexkit-2.1.1 → hexkit-3.0.0}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+   Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
    for the German Human Genome-Phenome Archive (GHGA)
 
    Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/MANIFEST.in

@@ -1 +1,2 @@
+include src/hexkit/py.typed
 include src/hexkit/providers/s3/test_files/*.yaml

{hexkit-2.1.1/src/hexkit.egg-info → hexkit-3.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hexkit
-Version: 2.1.1
+Version: 3.0.0
 Summary: A Toolkit for Building Microservices using the Hexagonal Architecture
 Author-email: "German Human Genome Phenome Archive (GHGA)" <contact@ghga.de>
 License: Apache 2.0
@@ -10,6 +10,7 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
 Classifier: Topic :: Software Development :: Libraries
@@ -21,8 +22,8 @@ Requires-Dist: pydantic<3,>=2
 Requires-Dist: pydantic_settings<3,>=2
 Requires-Dist: PyYAML<7,>=6.0
 Provides-Extra: akafka
-Requires-Dist: aiokafka~=0.8.0; extra == "akafka"
-Requires-Dist: jsonschema<5,>=4.17.3; extra == "akafka"
+Requires-Dist: aiokafka~=0.10.0; extra == "akafka"
+Requires-Dist: jsonschema<5,>=4.21; extra == "akafka"
 Provides-Extra: s3
 Requires-Dist: boto3<2,>=1.26.50; extra == "s3"
 Requires-Dist: botocore<2,>=1.29.50; extra == "s3"
@@ -30,13 +31,13 @@ Provides-Extra: mongodb
 Requires-Dist: motor<4,>=3.1.1; extra == "mongodb"
 Provides-Extra: test-akafka
 Requires-Dist: hexkit[akafka]; extra == "test-akafka"
-Requires-Dist: testcontainers[kafka]<4,>=3.7.1; extra == "test-akafka"
+Requires-Dist: testcontainers[kafka]<5,>=4.3.3; extra == "test-akafka"
 Provides-Extra: test-s3
 Requires-Dist: hexkit[s3]; extra == "test-s3"
-Requires-Dist: testcontainers<4,>=3.7.1; extra == "test-s3"
+Requires-Dist: testcontainers<5,>=4.3.3; extra == "test-s3"
 Provides-Extra: test-mongodb
 Requires-Dist: hexkit[mongodb]; extra == "test-mongodb"
-Requires-Dist: testcontainers[mongo]<4,>=3.7.1; extra == "test-mongodb"
+Requires-Dist: testcontainers[mongo]<5,>=4.3.3; extra == "test-mongodb"
 Provides-Extra: test
 Requires-Dist: hexkit[test-akafka,test-mongodb,test-s3]; extra == "test"
 Provides-Extra: all

{hexkit-2.1.1 → hexkit-3.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-    "setuptools>=67.7.2",
+    "setuptools>=69",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -16,13 +16,14 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "License :: OSI Approved :: Apache Software License",
     "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
     "Topic :: Software Development :: Libraries",
     "Intended Audience :: Developers",
 ]
 name = "hexkit"
-version = "2.1.1"
+version = "3.0.0"
 description = "A Toolkit for Building Microservices using the Hexagonal Architecture"
 dependencies = [
     "pydantic >=2, <3",
@@ -35,8 +36,8 @@ text = "Apache 2.0"
 
 [project.optional-dependencies]
 akafka = [
-    "aiokafka~=0.8.0",
-    "jsonschema >=4.17.3, <5",
+    "aiokafka~=0.10.0",
+    "jsonschema >=4.21, <5",
 ]
 s3 = [
     "boto3 >=1.26.50, <2",
@@ -47,15 +48,15 @@ mongodb = [
 ]
 test-akafka = [
     "hexkit[akafka]",
-    "testcontainers[kafka] >=3.7.1, <4",
+    "testcontainers[kafka] >=4.3.3, <5",
 ]
 test-s3 = [
     "hexkit[s3]",
-    "testcontainers >=3.7.1, <4",
+    "testcontainers >=4.3.3, <5",
 ]
 test-mongodb = [
     "hexkit[mongodb]",
-    "testcontainers[mongo] >=3.7.1, <4",
+    "testcontainers[mongo] >=4.3.3, <5",
 ]
 test = [
     "hexkit[test-akafka,test-s3,test-mongodb]",
@@ -80,9 +81,25 @@ exclude = [
     "build",
     "dist",
 ]
+line-length = 88
+src = [
+    "src",
+    "tests",
+    "examples",
+    "scripts",
+]
+target-version = "py39"
+
+[tool.ruff.lint]
+fixable = [
+    "UP",
+    "I",
+    "D",
+]
 ignore = [
-    "E",
-    "W",
+    "E111",
+    "E114",
+    "E116",
     "PLW",
     "RUF001",
     "RUF010",
@@ -97,7 +114,6 @@ ignore = [
     "D206",
     "D300",
 ]
-line-length = 88
 select = [
     "C90",
     "F",
@@ -111,23 +127,11 @@ select = [
     "SIM",
     "D",
 ]
-fixable = [
-    "UP",
-    "I",
-    "D",
-]
-src = [
-    "src",
-    "tests",
-    "examples",
-    "scripts",
-]
-target-version = "py39"
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 max-complexity = 10
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "scripts/*" = [
     "PL",
     "S",
@@ -153,7 +157,7 @@ max-complexity = 10
     "D",
 ]
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "pep257"
 
 [tool.mypy]
@@ -168,7 +172,7 @@ check_untyped_defs = true
 no_site_packages = false
 
 [tool.pytest.ini_options]
-minversion = "7.1"
+minversion = "8.0"
 asyncio_mode = "strict"
 
 [tool.coverage.paths]
@@ -179,4 +183,4 @@ source = [
 ]
 
 [tool.tox]
-legacy_tox_ini = "    [tox]\n    min_version = 4.0\n    env_list =\n        py39\n        py311\n\n    [testenv]\n    pass_env=\n        TC_HOST\n        DOCKER_HOST\n    deps =\n        --no-deps -r ./lock/requirements-dev.txt\n    commands = pytest ./tests {posargs}\n"
+legacy_tox_ini = "    [tox]\n    env_list = py3{9,12}\n\n    [gh-actions]\n    python =\n        3.9: py39\n        3.10: py310\n        3.11: py311\n        3.12: py312\n\n    [testenv]\n    pass_env =\n        TC_HOST\n        DOCKER_HOST\n    deps =\n        --no-deps -r ./lock/requirements-dev.txt\n    commands = pytest {posargs}\n"

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/__main__.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/base.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/config.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/correlation.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/custom_types.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/log.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/protocols/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/protocols/dao.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -268,10 +268,8 @@ async def uuid4_id_generator() -> AsyncGenerator[str, None]:
         yield str(uuid4())
 
 
-class DaoFactoryProtocol(ABC):
-    """A protocol describing a factory to produce Data Access Objects (DAO) objects
-    that are enclosed in transactional scopes.
-    """
+class DaoFactoryBase:
+    """A base for Data Access Objects (DAO) Factory protocols."""
 
     class IdFieldNotFoundError(ValueError):
         """Raised when the dto_model did not contain the expected id_field."""
@@ -335,6 +333,32 @@ class DaoFactoryProtocol(ABC):
                 f"Provided index fields are invalid: {error}"
             ) from error
 
+    @classmethod
+    def _validate(
+        cls,
+        *,
+        dto_model: type[Dto],
+        id_field: str,
+        dto_creation_model: Optional[type[DtoCreation]],
+        fields_to_index: Optional[Collection[str]],
+    ) -> None:
+        """Validates the input parameters of the get_dao method."""
+        cls._validate_dto_model_id(dto_model=dto_model, id_field=id_field)
+        cls._validate_dto_creation_model(
+            dto_model=dto_model,
+            dto_creation_model=dto_creation_model,
+            id_field=id_field,
+        )
+        cls._validate_fields_to_index(
+            dto_model=dto_model, fields_to_index=fields_to_index
+        )
+
+
+class DaoFactoryProtocol(DaoFactoryBase, ABC):
+    """A protocol describing a factory to produce Data Access Objects (DAO) objects
+    that are enclosed in transactional scopes.
+    """
+
     @overload
     async def get_dao(
         self,
@@ -344,8 +368,7 @@ class DaoFactoryProtocol(ABC):
         id_field: str,
         fields_to_index: Optional[Collection[str]] = None,
         id_generator: Optional[AsyncGenerator[str, None]] = None,
-    ) -> DaoNaturalId[Dto]:
-        ...
+    ) -> DaoNaturalId[Dto]: ...
 
     @overload
     async def get_dao(
@@ -357,8 +380,7 @@ class DaoFactoryProtocol(ABC):
         dto_creation_model: type[DtoCreation],
         fields_to_index: Optional[Collection[str]] = None,
         id_generator: Optional[AsyncGenerator[str, None]] = None,
-    ) -> DaoSurrogateId[Dto, DtoCreation]:
-        ...
+    ) -> DaoSurrogateId[Dto, DtoCreation]: ...
 
     async def get_dao(
         self,
@@ -408,16 +430,11 @@ class DaoFactoryProtocol(ABC):
             self.IdFieldNotFoundError:
                 Raised when the dto_model did not contain the expected id_field.
         """
-        self._validate_dto_model_id(dto_model=dto_model, id_field=id_field)
-
-        self._validate_dto_creation_model(
+        self._validate(
             dto_model=dto_model,
-            dto_creation_model=dto_creation_model,
             id_field=id_field,
-        )
-
-        self._validate_fields_to_index(
-            dto_model=dto_model, fields_to_index=fields_to_index
+            dto_creation_model=dto_creation_model,
+            fields_to_index=fields_to_index,
         )
 
         if id_generator is None:
@@ -430,7 +447,6 @@ class DaoFactoryProtocol(ABC):
             id_field=id_field,
             fields_to_index=fields_to_index,
             dto_creation_model=dto_creation_model,
-            # (above behavior by mypy seems incorrect)
             id_generator=id_generator,
         )
 
@@ -445,8 +461,7 @@ class DaoFactoryProtocol(ABC):
         dto_creation_model: None,
         fields_to_index: Optional[Collection[str]],
         id_generator: AsyncGenerator[str, None],
-    ) -> DaoNaturalId[Dto]:
-        ...
+    ) -> DaoNaturalId[Dto]: ...
 
     @overload
     @abstractmethod
@@ -459,8 +474,7 @@ class DaoFactoryProtocol(ABC):
         dto_creation_model: type[DtoCreation],
         fields_to_index: Optional[Collection[str]],
         id_generator: AsyncGenerator[str, None],
-    ) -> DaoSurrogateId[Dto, DtoCreation]:
-        ...
+    ) -> DaoSurrogateId[Dto, DtoCreation]: ...
 
     @abstractmethod
     async def _get_dao(

hexkit-3.0.0/src/hexkit/protocols/daopub.py

@@ -0,0 +1,130 @@
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# for the German Human Genome-Phenome Archive (GHGA)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""Protocol for creating Data Access Objects to perform CRUD (plus find) interactions
+with the database plus automatically publish the changes as events using a modification
+of the outbox pattern.
+"""
+
+# ruff: noqa: PLR0913
+
+import typing
+from abc import ABC, abstractmethod
+from collections.abc import Collection
+from typing import Callable, Optional
+
+from hexkit.custom_types import JsonObject
+from hexkit.protocols.dao import (
+    DaoFactoryBase,
+    DaoNaturalId,
+    Dto,
+)
+
+
+class DaoPublisher(DaoNaturalId[Dto], typing.Protocol[Dto]):
+    """A Data Access Object (DAO) that automatically publishes changes according to the
+    outbox pattern.
+    """
+
+    async def publish_pending(self) -> None:
+        """Publishes all non-published changes."""
+        ...
+
+    async def republish(self) -> None:
+        """Republishes the state of all resources independent of whether they have
+        already been published or not.
+        """
+        ...
+
+
+class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
+    """A protocol describing a factory to produce Data Access Objects (DAO) objects
+    which automatically publish changes according to the outbox pattern.
+    """
+
+    async def get_dao(
+        self,
+        *,
+        name: str,
+        dto_model: type[Dto],
+        id_field: str,
+        fields_to_index: Optional[Collection[str]] = None,
+        dto_to_event: Callable[[Dto], JsonObject],
+        event_topic: str,
+        autopublish: bool = True,
+    ) -> DaoPublisher[Dto]:
+        """Constructs an Outbox DAO for interacting with resources in a database.
+
+        Args:
+            name:
+                The name of the resource type (roughly equivalent to the name of a
+                database table or collection).
+            dto_model:
+                A DTO (Data Transfer Object) model describing the shape of resources.
+            id_field:
+                The name of the field of the `dto_model` that serves as resource ID.
+                (DAO implementation might use this field as primary key.)
+            fields_to_index:
+                Optionally, provide any fields that should be indexed in addition to the
+                `id_field`. Defaults to None.
+            dto_to_event:
+                A function that takes a DTO and returns the payload for an event.
+            event_topic:
+                The topic to which events should be published.
+            autopublish:
+                Whether to automatically publish changes. Defaults to True.
+
+        Returns:
+            A DAO of type DaoPublisher, which requires ID specification upon resource
+            creation.
+
+        Raises:
+            self.IdFieldNotFoundError:
+                Raised when the dto_model did not contain the expected id_field.
+        """
+        self._validate(
+            dto_model=dto_model,
+            id_field=id_field,
+            dto_creation_model=None,
+            fields_to_index=fields_to_index,
+        )
+
+        return await self._get_dao(
+            name=name,
+            dto_model=dto_model,
+            id_field=id_field,
+            fields_to_index=fields_to_index,
+            dto_to_event=dto_to_event,
+            event_topic=event_topic,
+            autopublish=autopublish,
+        )
+
+    @abstractmethod
+    async def _get_dao(
+        self,
+        *,
+        name: str,
+        dto_model: type[Dto],
+        id_field: str,
+        fields_to_index: Optional[Collection[str]],
+        dto_to_event: Callable[[Dto], JsonObject],
+        event_topic: str,
+        autopublish: bool,
+    ) -> DaoPublisher[Dto]:
+        """*To be implemented by the provider. Input validation is done outside of this
+        method.*
+        """
+        ...

hexkit-3.0.0/src/hexkit/protocols/daosub.py

@@ -0,0 +1,60 @@
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# for the German Human Genome-Phenome Archive (GHGA)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""A protocol for consuming events published through the DaoPublisherFactoryProtocol."""
+
+from abc import ABC, abstractmethod
+from typing import Generic, TypeVar
+
+from pydantic import BaseModel
+
+Dto = TypeVar("Dto", bound=BaseModel)
+
+
+class DtoValidationError(ValueError):
+    """Raised when the payload of a received event was not formatted as expected."""
+
+
+class DaoSubscriberProtocol(ABC, Generic[Dto]):
+    """A protocol for consuming events published through the DaoPublisherFactoryProtocol.
+
+    In addition to the methods described below, implementations shall expose the
+    the following attributes:
+            event_topic:
+                The name of the topic from which updates for the given resource are
+                consumed.
+            dto_model:
+                A pydantic model representing the data transfer object (DTO) for the
+                payload of changed events.
+
+    If the upstream provider using this protocol fails to convert the payload of a
+    change event to the expected DTO model, it should raise a DtoValidationError.
+    """
+
+    event_topic: str
+    dto_model: type[Dto]
+
+    @abstractmethod
+    async def changed(self, resource_id: str, update: Dto) -> None:
+        """Consume a change event (created or updated) for the resource with the given
+        ID.
+        """
+        ...
+
+    @abstractmethod
+    async def deleted(self, resource_id: str) -> None:
+        """Consume an event indicating the deletion of the resource with the given ID."""
+        ...

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/protocols/eventpub.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/protocols/eventsub.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -45,27 +45,47 @@ class EventSubscriberProtocol(ABC):
     topics_of_interest: list[Ascii]
     types_of_interest: list[Ascii]
 
-    async def consume(self, *, payload: JsonObject, type_: Ascii, topic: Ascii) -> None:
+    async def consume(
+        self,
+        *,
+        payload: JsonObject,
+        type_: Ascii,
+        topic: Ascii,
+        key: Ascii,
+    ) -> None:
         """Receive an event of interest and process it according to its type.
 
         Args:
-            payload (JsonObject): The data/payload to send with the event.
-            type_ (str): The type of the event.
-            topic (str): Name of the topic the event was published to.
+            payload: The data/payload to send with the event.
+            type_: The type of the event.
+            topic: Name of the topic the event was published to.
+            key: A key used for routing the event.
         """
         check_ascii(type_, topic)
-        await self._consume_validated(payload=payload, type_=type_, topic=topic)
+
+        if key:
+            check_ascii(key)
+
+        await self._consume_validated(
+            payload=payload, type_=type_, topic=topic, key=key
+        )
 
     @abstractmethod
     async def _consume_validated(
-        self, *, payload: JsonObject, type_: Ascii, topic: Ascii
+        self,
+        *,
+        payload: JsonObject,
+        type_: Ascii,
+        topic: Ascii,
+        key: Ascii,
     ) -> None:
         """
-        Receive and process an event with already validated topic and type.
+        Receive and process an event with already validated topic, type, and key.
 
         Args:
-            payload (JsonObject): The data/payload to send with the event.
-            type_ (str): The type of the event.
-            topic (str): Name of the topic the event was published to.
+            payload: The data/payload to send with the event.
+            type_: The type of the event.
+            topic: Name of the topic the event was published to.
+            key: A key used for routing the event.
         """
         ...

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/protocols/objstorage.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/providers/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{hexkit-2.1.1 → hexkit-3.0.0}/src/hexkit/providers/akafka/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2021 - 2023 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
+# Copyright 2021 - 2024 Universität Tübingen, DKFZ, EMBL, and Universität zu Köln
 # for the German Human Genome-Phenome Archive (GHGA)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,10 +19,16 @@ They correspond to the `EventPublisherProtocol` and `EventSubscriberProtocol`,
 respectively.
 """
 
+from .config import KafkaConfig
 from .provider import (
-    KafkaConfig,
     KafkaEventPublisher,
     KafkaEventSubscriber,
+    KafkaOutboxSubscriber,
 )
 
-__all__ = ["KafkaEventPublisher", "KafkaEventSubscriber", "KafkaConfig"]
+__all__ = [
+    "KafkaEventPublisher",
+    "KafkaEventSubscriber",
+    "KafkaConfig",
+    "KafkaOutboxSubscriber",
+]