lucos-schedule-tracker-pythonclient 1.0.31__py3-none-any.whl → 2.0.1__py3-none-any.whl

lucos_schedule_tracker_pythonclient-2.0.1.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: lucos_schedule_tracker_pythonclient
+Version: 2.0.1
+Summary: Python library for sending updates to lucos_schedule_tracker
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28
+
+# lucos_schedule_tracker_pythonclient
+
+Python library for sending updates to [lucos_schedule_tracker](https://github.com/lucas42/lucos_schedule_tracker).
+
+This library posts to the v2 `/report-status` endpoint. See [ADR-0004](https://github.com/lucas42/lucos/blob/main/docs/adr/0004-scheduled-jobs-monitoring-architecture.md) for the architectural background on `system` vs `job_name`.
+
+## Configuration
+
+The following environment variables must be set for the library to function:
+
+*   **`SYSTEM`**: A unique identifier for the system being tracked. This is used as the `User-Agent` header and as the default `system` name in reports.
+*   **`SCHEDULE_TRACKER_ENDPOINT`**: The v2 report endpoint URL of the `lucos_schedule_tracker` instance (e.g., `https://schedule-tracker.example.com/v2/report-status`). The URL must contain `/v2/` — the library validates this at startup and exits with an error if it does not.
+
+## Usage
+
+```python
+from schedule_tracker import updateScheduleTracker
+
+# Report a successful run
+updateScheduleTracker(True, "ingestor_dbpedia")
+
+# Report a failure with a message
+updateScheduleTracker(False, "ingestor_loc", message="Database connection failed")
+```
+
+## API Reference
+
+### `updateScheduleTracker(success: bool, job_name: str, system: str = SYSTEM, message: str | None = None, frequency: int = 86400)`
+
+Sends a status update to the v2 schedule tracker endpoint.
+
+*   **`success`** (*bool*, required): Whether the job completed successfully.
+*   **`job_name`** (*str*, required): A sub-job identifier within the system (e.g. `"ingestor_dbpedia_meanOfTransportation"`). Naming the job explicitly makes it easier to add further jobs to the same system later without schema changes.
+*   **`system`** (*str*, optional): The identifier for the owning system (e.g. `"lucos_arachne"`). Defaults to the value of the `SYSTEM` environment variable.
+*   **`message`** (*str | None*, optional): A human-readable message, typically used to provide details on failure.
+*   **`frequency`** (*int*, optional): How often the job is expected to run, in seconds. Defaults to `86400` (24 hours).

lucos_schedule_tracker_pythonclient-2.0.1.dist-info/RECORD

@@ -0,0 +1,5 @@
+schedule_tracker.py,sha256=NChovy2osw_O1DPcSYZa-5av0Hr1IN9OLA3Hj5ViBJQ,2563
+lucos_schedule_tracker_pythonclient-2.0.1.dist-info/METADATA,sha256=12oaRGUyON6D4AsESTSzfYjWSEsiQn08oyeRG4OicYY,2400
+lucos_schedule_tracker_pythonclient-2.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+lucos_schedule_tracker_pythonclient-2.0.1.dist-info/top_level.txt,sha256=8rZs9mXbH-upOjeJSeQXcwZEWqs4pHwz-WbF83YVy7Y,17
+lucos_schedule_tracker_pythonclient-2.0.1.dist-info/RECORD,,

schedule_tracker.py

@@ -1,5 +1,6 @@
 import os, sys, requests
 from datetime import datetime
+from typing import Optional
 
 try:
 	SYSTEM = os.environ["SYSTEM"]
@@ -8,7 +9,10 @@ except KeyError:
 try:
 	SCHEDULE_TRACKER_ENDPOINT = os.environ["SCHEDULE_TRACKER_ENDPOINT"]
 except KeyError:
-	sys.exit("\033[91mSCHEDULE_TRACKER_ENDPOINT environment variable not set - needs to be the URL of a running lucos_schedule_tracker instance\033[0m")
+	sys.exit("\033[91mSCHEDULE_TRACKER_ENDPOINT environment variable not set - must be the v2 endpoint URL of a running lucos_schedule_tracker instance (e.g. http://host/v2/report-status)\033[0m")
+
+if "/v2/" not in SCHEDULE_TRACKER_ENDPOINT:
+	sys.exit("\033[91mSCHEDULE_TRACKER_ENDPOINT must point at the v2 endpoint (e.g. http://host/v2/report-status) — got: {}\033[0m".format(SCHEDULE_TRACKER_ENDPOINT))
 
 session = requests.Session()
 session.headers.update({
@@ -16,12 +20,21 @@ session.headers.update({
 	"Content-Type": "application/json",
 })
 
-def updateScheduleTracker(success: bool, system: str = SYSTEM, message: str = None, frequency: int = (24 * 60 * 60)):
+def updateScheduleTracker(success: bool, job_name: str, system: str = SYSTEM, message: Optional[str] = None, frequency: int = (24 * 60 * 60)):
 	"""Report the outcome of a scheduled run to lucos_schedule_tracker.
 
+	Posts to the v2 /report-status endpoint.
+
 	Args:
 		success: Whether the job completed successfully.
-		system: Identifier of the calling system. Defaults to the SYSTEM env var.
+		job_name: Sub-job identifier within the system (e.g.
+			"ingestor_dbpedia_meanOfTransportation"). Required — naming the job
+			explicitly makes it easier to add further jobs to the same system
+			later without schema changes. See ADR-0004 for the architectural
+			background:
+			https://github.com/lucas42/lucos/blob/main/docs/adr/0004-scheduled-jobs-monitoring-architecture.md
+		system: Identifier of the owning system (e.g. "lucos_arachne"). Defaults
+			to the SYSTEM env var.
 		message: Optional human-readable detail, typically used to describe a
 			failure.
 		frequency: How often this job is genuinely scheduled to run, in seconds.
@@ -33,6 +46,7 @@ def updateScheduleTracker(success: bool, system: str = SYSTEM, message: str = No
 	"""
 	payload = {
 		"system": system,
+		"job_name": job_name,
 		"frequency": frequency,
 		"status": "success" if success else "error",
 		"message": message,
@@ -41,4 +55,4 @@ def updateScheduleTracker(success: bool, system: str = SYSTEM, message: str = No
 		schedule_tracker_response = requests.post(SCHEDULE_TRACKER_ENDPOINT, json=payload, timeout=30)
 		schedule_tracker_response.raise_for_status()
 	except Exception as error:
-		print("\033[91m [{}] ** Error calling schedule-tracker: {}\033[0m".format(datetime.now().isoformat(), error), flush=True)
+		print("\033[91m [{}] ** Error calling schedule-tracker: {}\033[0m".format(datetime.now().isoformat(), error), flush=True)

lucos_schedule_tracker_pythonclient-1.0.31.dist-info/METADATA

@@ -1,42 +0,0 @@
-Metadata-Version: 2.4
-Name: lucos_schedule_tracker_pythonclient
-Version: 1.0.31
-Summary: Python library for sending updates to lucos_schedule_tracker
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: requests>=2.28
-
-# lucos_schedule_tracker_pythonclient
-
-Python library for sending updates to [lucos_schedule_tracker](https://github.com/lucas42/lucos_schedule_tracker).
-
-## Configuration
-
-The following environment variables must be set for the library to function:
-
-*   **`SYSTEM`**: A unique identifier for the system or job being tracked. This is used as the `User-Agent` header and as the default `system` name in reports.
-*   **`SCHEDULE_TRACKER_ENDPOINT`**: The full URL of the `lucos_schedule_tracker` instance's report endpoint (e.g., `https://schedule-tracker.example.com/report-status`).
-
-## Usage
-
-```python
-from schedule_tracker import updateScheduleTracker
-
-# Report a successful run
-updateScheduleTracker(success=True)
-
-# Report a failure with a message
-updateScheduleTracker(success=False, message="Database connection failed")
-```
-
-## API Reference
-
-### `updateScheduleTracker(success: bool, system: str = SYSTEM, message: str = None, frequency: int = 86400)`
-
-Sends a status update to the schedule tracker.
-
-*   **`success`** (*bool*, required): Whether the job completed successfully.
-*   **`system`** (*str*, optional): The identifier for the system. Defaults to the value of the `SYSTEM` environment variable.
-*   **`message`** (*str*, optional): A human-readable message, typically used to provide details on failure.
-*   **`frequency`** (*int*, optional): How often the job is expected to run, in seconds. Defaults to `86400` (24 hours).

lucos_schedule_tracker_pythonclient-1.0.31.dist-info/RECORD

@@ -1,5 +0,0 @@
-schedule_tracker.py,sha256=FJ-ZEmhbNohnfNPFdkdjY_DFaHqmdU3LInTDfhjs3lM,1780
-lucos_schedule_tracker_pythonclient-1.0.31.dist-info/METADATA,sha256=AoPknVD2LsD06_J9Y86xDDaGc3OvAXkV5Fa3rzS3XJ4,1736
-lucos_schedule_tracker_pythonclient-1.0.31.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-lucos_schedule_tracker_pythonclient-1.0.31.dist-info/top_level.txt,sha256=8rZs9mXbH-upOjeJSeQXcwZEWqs4pHwz-WbF83YVy7Y,17
-lucos_schedule_tracker_pythonclient-1.0.31.dist-info/RECORD,,