lucos-loganne-pythonclient 1.0.37__tar.gz → 2.0.0__tar.gz

{lucos_loganne_pythonclient-1.0.37 → lucos_loganne_pythonclient-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lucos_loganne_pythonclient
-Version: 1.0.37
+Version: 2.0.0
 Summary: A python client for sending events to lucos_loganne
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
@@ -19,11 +19,16 @@ The following environment variables must be set for the package to function:
 ## API
 The package exposes a single function:
 
-### `updateLoganne(type, humanReadable, url=None, **extra_data)`
+### `updateLoganne(type, humanReadable, level, 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.
+* **level** (str, required): The editorial prominence of the event. Must be one of:
+  * `detail` — mechanical/low-interest churn, hidden from the default feed.
+  * `routine` — regular estate activity (the most common level).
+  * `notable` — worth emphasising in-feed.
+  * `headline` — estate-significant, suitable for a homepage glance.
 * **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).
 
@@ -35,6 +40,7 @@ from loganne import updateLoganne
 updateLoganne(
     type="contactUpdated",
     humanReadable="The Contact \"John Doe\" has been updated",
+    level="routine",
     url="https://contacts.example.com/contact/123456"
 )
 
@@ -42,6 +48,7 @@ updateLoganne(
 updateLoganne(
     type="entityMerged",
     humanReadable="Contact \"Old Name\" merged into \"New Name\"",
+    level="notable",
     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.37 → lucos_loganne_pythonclient-2.0.0}/README.md

@@ -10,11 +10,16 @@ The following environment variables must be set for the package to function:
 ## API
 The package exposes a single function:
 
-### `updateLoganne(type, humanReadable, url=None, **extra_data)`
+### `updateLoganne(type, humanReadable, level, 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.
+* **level** (str, required): The editorial prominence of the event. Must be one of:
+  * `detail` — mechanical/low-interest churn, hidden from the default feed.
+  * `routine` — regular estate activity (the most common level).
+  * `notable` — worth emphasising in-feed.
+  * `headline` — estate-significant, suitable for a homepage glance.
 * **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).
 
@@ -26,6 +31,7 @@ from loganne import updateLoganne
 updateLoganne(
     type="contactUpdated",
     humanReadable="The Contact \"John Doe\" has been updated",
+    level="routine",
     url="https://contacts.example.com/contact/123456"
 )
 
@@ -33,6 +39,7 @@ updateLoganne(
 updateLoganne(
     type="entityMerged",
     humanReadable="Contact \"Old Name\" merged into \"New Name\"",
+    level="notable",
     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.37 → lucos_loganne_pythonclient-2.0.0}/loganne.py

@@ -16,11 +16,16 @@ session.headers.update({
 	"Content-Type": "application/json",
 })
 
-def updateLoganne(type: str, humanReadable: str, url: str = None, **extra_data):
+VALID_LEVELS = {"detail", "routine", "notable", "headline"}
+
+def updateLoganne(type: str, humanReadable: str, level: str, url: str = None, **extra_data):
+	if level not in VALID_LEVELS:
+		raise ValueError(f"Invalid level '{level}'. Must be one of: {', '.join(sorted(VALID_LEVELS))}")
 	payload = {
 		"type": type,
 		"source": SYSTEM,
 		"humanReadable": humanReadable,
+		"level": level,
 	}
 	if url:
 		payload["url"] = url

{lucos_loganne_pythonclient-1.0.37 → lucos_loganne_pythonclient-2.0.0}/lucos_loganne_pythonclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lucos_loganne_pythonclient
-Version: 1.0.37
+Version: 2.0.0
 Summary: A python client for sending events to lucos_loganne
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
@@ -19,11 +19,16 @@ The following environment variables must be set for the package to function:
 ## API
 The package exposes a single function:
 
-### `updateLoganne(type, humanReadable, url=None, **extra_data)`
+### `updateLoganne(type, humanReadable, level, 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.
+* **level** (str, required): The editorial prominence of the event. Must be one of:
+  * `detail` — mechanical/low-interest churn, hidden from the default feed.
+  * `routine` — regular estate activity (the most common level).
+  * `notable` — worth emphasising in-feed.
+  * `headline` — estate-significant, suitable for a homepage glance.
 * **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).
 
@@ -35,6 +40,7 @@ from loganne import updateLoganne
 updateLoganne(
     type="contactUpdated",
     humanReadable="The Contact \"John Doe\" has been updated",
+    level="routine",
     url="https://contacts.example.com/contact/123456"
 )
 
@@ -42,6 +48,7 @@ updateLoganne(
 updateLoganne(
     type="entityMerged",
     humanReadable="Contact \"Old Name\" merged into \"New Name\"",
+    level="notable",
     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.37 → lucos_loganne_pythonclient-2.0.0}/pyproject.toml

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