hexkit 5.1.1__tar.gz → 5.3.0__tar.gz

{hexkit-5.1.1/src/hexkit.egg-info → hexkit-5.3.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: hexkit
-Version: 5.1.1
+Version: 5.3.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
 Project-URL: Repository, https://github.com/ghga-de/hexkit
-Classifier: Development Status :: 1 - Planning
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -24,7 +24,7 @@ Requires-Dist: pydantic<3,>=2.10
 Requires-Dist: pydantic_settings<3,>=2.8
 Requires-Dist: PyYAML<7,>=6
 Provides-Extra: akafka
-Requires-Dist: aiokafka~=0.12.0; extra == "akafka"
+Requires-Dist: aiokafka[lz4,snappy,zstd]~=0.12.0; extra == "akafka"
 Requires-Dist: jsonschema<5,>=4.23; extra == "akafka"
 Provides-Extra: s3
 Requires-Dist: boto3<2,>=1.37; extra == "s3"

{hexkit-5.1.1 → hexkit-5.3.0}/pyproject.toml

@@ -11,7 +11,7 @@ authors = [
 ]
 requires-python = ">=3.9"
 classifiers = [
-    "Development Status :: 1 - Planning",
+    "Development Status :: 5 - Production/Stable",
     "Operating System :: POSIX :: Linux",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -24,7 +24,7 @@ classifiers = [
     "Intended Audience :: Developers",
 ]
 name = "hexkit"
-version = "5.1.1"
+version = "5.3.0"
 description = "A Toolkit for Building Microservices using the Hexagonal Architecture"
 dependencies = [
     "opentelemetry-api >=1.31.1, <2",
@@ -38,7 +38,7 @@ text = "Apache 2.0"
 
 [project.optional-dependencies]
 akafka = [
-    "aiokafka~=0.12.0",
+    "aiokafka[zstd,lz4,snappy]~=0.12.0",
     "jsonschema >=4.23, <5",
 ]
 s3 = [
@@ -102,6 +102,9 @@ all = [
 [project.urls]
 Repository = "https://github.com/ghga-de/hexkit"
 
+[project.entry-points.opentelemetry_distro]
+hexkit_distro = "hexkit.opentelemetry:HexkitDistro"
+
 [tool.setuptools.packages.find]
 where = [
     "src",

{hexkit-5.1.1 → hexkit-5.3.0}/src/hexkit/custom_types.py

@@ -96,3 +96,6 @@ AsyncContextConstructable = Any
 
 # The possible scopes for pytest fixtures
 PytestScope = Literal["session", "package", "module", "class", "function"]
+
+# The possible compression types for Kafka messages
+KafkaCompressionType = Literal["gzip", "snappy", "lz4", "zstd"]

{hexkit-5.1.1 → hexkit-5.3.0}/src/hexkit/opentelemetry.py

@@ -25,6 +25,9 @@ from opentelemetry.environment_variables import (
     OTEL_TRACES_EXPORTER,
 )
 from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.instrumentation.distro import (  # type: ignore[attr-defined]
+    BaseDistro,
+)
 from opentelemetry.sdk.environment_variables import (
     OTEL_EXPORTER_OTLP_ENDPOINT,
     OTEL_EXPORTER_OTLP_PROTOCOL,
@@ -95,6 +98,16 @@ class OpenTelemetryConfig(BaseSettings):
     )
 
 
+class HexkitDistro(BaseDistro):
+    """
+    Custom OpenTelemetry Distro configuring a default set of configuration
+    based on a config file.
+    """
+
+    def _configure(self, **kwargs):
+        """Custom DefaultDistro iplementation to provide autoinstrumentation entry points."""
+
+
 def configure_opentelemetry(*, service_name: str, config: OpenTelemetryConfig):
     """Configure all needed parts of OpenTelemetry.
 
@@ -143,8 +156,8 @@ def configure_opentelemetry(*, service_name: str, config: OpenTelemetryConfig):
 
 def start_span(
     *,
-    record_exception: bool = False,
-    set_status_on_exception: bool = False,
+    record_exception: bool = True,
+    set_status_on_exception: bool = True,
 ) -> Callable:
     """Returns decorated or undecorated function depending on if TRACER is instantiated.
 

{hexkit-5.1.1 → hexkit-5.3.0}/src/hexkit/providers/akafka/config.py

@@ -16,11 +16,13 @@
 
 """Apache Kafka specific configuration."""
 
-from typing import Literal
+from typing import Literal, Optional
 
 from pydantic import Field, NonNegativeInt, PositiveInt, SecretStr
 from pydantic_settings import BaseSettings
 
+from hexkit.custom_types import KafkaCompressionType
+
 
 class KafkaConfig(BaseSettings):
     """Config parameters needed for connecting to Apache Kafka."""
@@ -78,10 +80,26 @@ class KafkaConfig(BaseSettings):
     )
     kafka_max_message_size: PositiveInt = Field(
         default=1024 * 1024,  # 1 MiB
-        description="The largest message size that can be transmitted, in bytes. Only"
-        + " services that have a need to send/receive larger messages should set this.",
+        description="The largest message size that can be transmitted, in bytes, before"
+        + " compression. Only services that have a need to send/receive larger"
+        + " messages should set this. When used alongside compression, this value"
+        + " can be set to something greater than the broker's `message.max.bytes`"
+        + " field, which effectively concerns the compressed message size.",
         examples=[1024 * 1024, 16 * 1024 * 1024],
     )
+    kafka_compression_type: Optional[KafkaCompressionType] = Field(
+        default=None,
+        description=(
+            "The compression type used for messages. Valid values are: None, gzip,"
+            + " snappy, lz4, and zstd. If None, no compression is applied. This"
+            + " setting is only relevant for the producer and has no effect on the"
+            + " consumer. If set to a value, the producer will compress messages before"
+            + " sending them to the Kafka broker. If unsure, zstd provides a good"
+            + " balance between speed and compression ratio."
+        ),
+        title="Kafka Compression Type",
+        examples=[None, "gzip", "snappy", "lz4", "zstd"],
+    )
     kafka_max_retries: NonNegativeInt = Field(
         default=0,
         description=(

{hexkit-5.1.1 → hexkit-5.3.0}/src/hexkit/providers/akafka/provider/eventpub.py

@@ -37,7 +37,7 @@ from hexkit.correlation import (
     new_correlation_id,
     validate_correlation_id,
 )
-from hexkit.custom_types import Ascii, JsonObject
+from hexkit.custom_types import Ascii, JsonObject, KafkaCompressionType
 from hexkit.protocols.eventpub import EventPublisherProtocol
 from hexkit.providers.akafka.config import KafkaConfig
 from hexkit.providers.akafka.provider.utils import (
@@ -61,6 +61,7 @@ class KafkaProducerCompatible(Protocol):
         key_serializer: Callable[[Any], bytes],
         value_serializer: Callable[[Any], bytes],
         max_request_size: int,
+        compression_type: Optional[KafkaCompressionType] = None,
     ):
         """
         Initialize the producer with some config params.
@@ -76,6 +77,8 @@ class KafkaProducerCompatible(Protocol):
                 Function to serialize the values into bytes.
             max_request_size:
                 Maximum sendable message size.
+            compression_type:
+                Compression type to use for messages. Defaults to None.
         """
         ...
 
@@ -124,6 +127,7 @@ class KafkaEventPublisher(EventPublisherProtocol):
             key_serializer=lambda key: key.encode("ascii"),
             value_serializer=cls._default_event_value_serializer,
             max_request_size=config.kafka_max_message_size,
+            compression_type=config.kafka_compression_type,
         )
 
         try:

{hexkit-5.1.1 → hexkit-5.3.0/src/hexkit.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: hexkit
-Version: 5.1.1
+Version: 5.3.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
 Project-URL: Repository, https://github.com/ghga-de/hexkit
-Classifier: Development Status :: 1 - Planning
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -24,7 +24,7 @@ Requires-Dist: pydantic<3,>=2.10
 Requires-Dist: pydantic_settings<3,>=2.8
 Requires-Dist: PyYAML<7,>=6
 Provides-Extra: akafka
-Requires-Dist: aiokafka~=0.12.0; extra == "akafka"
+Requires-Dist: aiokafka[lz4,snappy,zstd]~=0.12.0; extra == "akafka"
 Requires-Dist: jsonschema<5,>=4.23; extra == "akafka"
 Provides-Extra: s3
 Requires-Dist: boto3<2,>=1.37; extra == "s3"

{hexkit-5.1.1 → hexkit-5.3.0}/src/hexkit.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ src/hexkit/utils.py
 src/hexkit.egg-info/PKG-INFO
 src/hexkit.egg-info/SOURCES.txt
 src/hexkit.egg-info/dependency_links.txt
+src/hexkit.egg-info/entry_points.txt
 src/hexkit.egg-info/requires.txt
 src/hexkit.egg-info/top_level.txt
 src/hexkit/protocols/__init__.py

hexkit-5.3.0/src/hexkit.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[opentelemetry_distro]
+hexkit_distro = hexkit.opentelemetry:HexkitDistro

{hexkit-5.1.1 → hexkit-5.3.0}/src/hexkit.egg-info/requires.txt

@@ -4,7 +4,7 @@ pydantic_settings<3,>=2.8
 PyYAML<7,>=6
 
 [akafka]
-aiokafka~=0.12.0
+aiokafka[lz4,snappy,zstd]~=0.12.0
 jsonschema<5,>=4.23
 
 [all]