Added abstract event class.

Author: pantierra

.pre-commit-config.yaml

@@ -9,6 +9,7 @@ repos:
     rev: v1.17.1
     hooks:
       - id: mypy
+        additional_dependencies: [pydantic>=2.11.7, loguru>=0.7.3]
   - repo: local
     hooks:
       - id: pytest-coverage

eoapi_notifier/core/event.py

@@ -0,0 +1,36 @@
+"""
+Event.
+
+Data object to hold information about notification events.
+"""
+
+from datetime import UTC, datetime
+from typing import Any
+from uuid import uuid4
+
+from pydantic import BaseModel, Field
+
+
+class NotificationEvent(BaseModel):
+    """
+    Definition of a notification event and its content.
+
+    Attributes:
+        id: Unique event identifier
+        source: Event source (e.g., "/eoapi/stac/pgstac")
+        type: Event type (e.g., "org.eoapi.stac.item")
+        operation: Operation performed (INSERT, UPDATE, DELETE)
+        collection: STAC collection ID
+        item_id: STAC item ID
+        timestamp: Event timestamp
+        data: Additional event data
+    """
+
+    id: str = Field(default_factory=lambda: str(uuid4()))
+    source: str
+    type: str
+    operation: str
+    collection: str
+    item_id: str | None = None
+    timestamp: datetime = Field(default_factory=lambda: datetime.now(UTC))
+    data: dict[str, Any] = Field(default_factory=dict)

eoapi_notifier/logging.py

@@ -1,20 +1,17 @@
 """Logging utilities for eoapi_notifier using loguru."""
 
 import sys
-from typing import TYPE_CHECKING, Any
+from typing import Any
 
 from loguru import logger
 
-if TYPE_CHECKING:
-    from loguru._logger import Logger
-
 
 def setup_logging(
     level: str | int = "INFO",
     format_string: str | None = None,
     include_timestamp: bool = True,
     sink: Any | None = None,
-) -> "Logger":
+) -> Any:
     """Set up logging for the eoapi_notifier package using loguru.
 
     Args:
@@ -62,7 +59,7 @@ def setup_logging(
     return logger
 
 
-def get_logger(name: str | None = None) -> "Logger":
+def get_logger(name: str | None = None) -> Any:
     """Get a logger instance for the eoapi_notifier package.
 
     With loguru, there's typically one global logger instance,

pyproject.toml

@@ -12,6 +12,7 @@ authors = [
 ]
 dependencies = [
     "loguru>=0.7.3",
+    "pydantic>=2.11.7",
 ]
 readme = "README.md"
 license = { text = "MIT" }
@@ -49,8 +50,6 @@ ignore = []
 [tool.ruff.format]
 quote-style = "double"
 indent-style = "space"
-skip-magic-trailing-comma = false
-line-ending = "auto"
 
 [tool.mypy]
 python_version = "3.12"