lucos-loganne-pythonclient 1.0.25__tar.gz → 1.0.27__tar.gz

{lucos_loganne_pythonclient-1.0.25 → lucos_loganne_pythonclient-1.0.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lucos_loganne_pythonclient
-Version: 1.0.25
+Version: 1.0.27
 Summary: A python client for sending events to lucos_loganne
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
@@ -19,12 +19,13 @@ The following environment variables must be set for the package to function:
 ## API
 The package exposes a single function:
 
-### `updateLoganne(type, humanReadable, url=None)`
+### `updateLoganne(type, humanReadable, url=None, **extra_data)`
 Sends an event to the Loganne service.
 
 * **type** (str, required): The type of event being logged.
 * **humanReadable** (str, required): A description of the event that is easy for humans to understand.
 * **url** (str, optional): A link to a human-readable page regarding the item the event pertains to. Defaults to `None`.
+* **\*\*extra_data** (optional): Any additional keyword arguments are forwarded as extra fields in the event payload. Useful for attaching structured data to events (e.g. multiple URIs, identifiers, or other context).
 
 ## Usage
 ```python
@@ -36,5 +37,14 @@ updateLoganne(
     humanReadable="The Contact \"John Doe\" has been updated",
     url="https://contacts.example.com/contact/123456"
 )
+
+# With extra structured data
+updateLoganne(
+    type="entityMerged",
+    humanReadable="Contact \"Old Name\" merged into \"New Name\"",
+    url="https://contacts.example.com/contact/789",
+    sourceUri="https://contacts.example.com/contact/123",
+    targetUri="https://contacts.example.com/contact/789",
+)
 ```
 

{lucos_loganne_pythonclient-1.0.25 → lucos_loganne_pythonclient-1.0.27}/README.md

@@ -10,12 +10,13 @@ The following environment variables must be set for the package to function:
 ## API
 The package exposes a single function:
 
-### `updateLoganne(type, humanReadable, url=None)`
+### `updateLoganne(type, humanReadable, url=None, **extra_data)`
 Sends an event to the Loganne service.
 
 * **type** (str, required): The type of event being logged.
 * **humanReadable** (str, required): A description of the event that is easy for humans to understand.
 * **url** (str, optional): A link to a human-readable page regarding the item the event pertains to. Defaults to `None`.
+* **\*\*extra_data** (optional): Any additional keyword arguments are forwarded as extra fields in the event payload. Useful for attaching structured data to events (e.g. multiple URIs, identifiers, or other context).
 
 ## Usage
 ```python
@@ -27,5 +28,14 @@ updateLoganne(
     humanReadable="The Contact \"John Doe\" has been updated",
     url="https://contacts.example.com/contact/123456"
 )
+
+# With extra structured data
+updateLoganne(
+    type="entityMerged",
+    humanReadable="Contact \"Old Name\" merged into \"New Name\"",
+    url="https://contacts.example.com/contact/789",
+    sourceUri="https://contacts.example.com/contact/123",
+    targetUri="https://contacts.example.com/contact/789",
+)
 ```
 

{lucos_loganne_pythonclient-1.0.25 → lucos_loganne_pythonclient-1.0.27}/loganne.py

@@ -16,7 +16,7 @@ session.headers.update({
 	"Content-Type": "application/json",
 })
 
-def updateLoganne(type: str, humanReadable: str, url: str = None):
+def updateLoganne(type: str, humanReadable: str, url: str = None, **extra_data):
 	payload = {
 		"type": type,
 		"source": SYSTEM,
@@ -24,6 +24,7 @@ def updateLoganne(type: str, humanReadable: str, url: str = None):
 	}
 	if url:
 		payload["url"] = url
+	payload.update(extra_data)
 	try:
 		loganne_response = session.post(LOGANNE_ENDPOINT, json=payload)
 		loganne_response.raise_for_status()

{lucos_loganne_pythonclient-1.0.25 → lucos_loganne_pythonclient-1.0.27}/lucos_loganne_pythonclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lucos_loganne_pythonclient
-Version: 1.0.25
+Version: 1.0.27
 Summary: A python client for sending events to lucos_loganne
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
@@ -19,12 +19,13 @@ The following environment variables must be set for the package to function:
 ## API
 The package exposes a single function:
 
-### `updateLoganne(type, humanReadable, url=None)`
+### `updateLoganne(type, humanReadable, url=None, **extra_data)`
 Sends an event to the Loganne service.
 
 * **type** (str, required): The type of event being logged.
 * **humanReadable** (str, required): A description of the event that is easy for humans to understand.
 * **url** (str, optional): A link to a human-readable page regarding the item the event pertains to. Defaults to `None`.
+* **\*\*extra_data** (optional): Any additional keyword arguments are forwarded as extra fields in the event payload. Useful for attaching structured data to events (e.g. multiple URIs, identifiers, or other context).
 
 ## Usage
 ```python
@@ -36,5 +37,14 @@ updateLoganne(
     humanReadable="The Contact \"John Doe\" has been updated",
     url="https://contacts.example.com/contact/123456"
 )
+
+# With extra structured data
+updateLoganne(
+    type="entityMerged",
+    humanReadable="Contact \"Old Name\" merged into \"New Name\"",
+    url="https://contacts.example.com/contact/789",
+    sourceUri="https://contacts.example.com/contact/123",
+    targetUri="https://contacts.example.com/contact/789",
+)
 ```
 

{lucos_loganne_pythonclient-1.0.25 → lucos_loganne_pythonclient-1.0.27}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lucos_loganne_pythonclient"
-version = "1.0.25"
+version = "1.0.27"
 description = "A python client for sending events to lucos_loganne"
 readme = "README.md"
 requires-python = ">=3.8"