lucos-schedule-tracker-pythonclient 1.0.28__tar.gz → 1.0.29__tar.gz

{lucos_schedule_tracker_pythonclient-1.0.28 → lucos_schedule_tracker_pythonclient-1.0.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lucos_schedule_tracker_pythonclient
-Version: 1.0.28
+Version: 1.0.29
 Summary: Python library for sending updates to lucos_schedule_tracker
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8

{lucos_schedule_tracker_pythonclient-1.0.28 → lucos_schedule_tracker_pythonclient-1.0.29}/lucos_schedule_tracker_pythonclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lucos_schedule_tracker_pythonclient
-Version: 1.0.28
+Version: 1.0.29
 Summary: Python library for sending updates to lucos_schedule_tracker
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8

{lucos_schedule_tracker_pythonclient-1.0.28 → lucos_schedule_tracker_pythonclient-1.0.29}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lucos_schedule_tracker_pythonclient"
-version = "1.0.28"
+version = "1.0.29"
 description = "Python library for sending updates to lucos_schedule_tracker"
 readme = "README.md"
 requires-python = ">=3.8"

{lucos_schedule_tracker_pythonclient-1.0.28 → lucos_schedule_tracker_pythonclient-1.0.29}/schedule_tracker.py

@@ -17,6 +17,20 @@ session.headers.update({
 })
 
 def updateScheduleTracker(success: bool, system: str = SYSTEM, message: str = None, frequency: int = (24 * 60 * 60)):
+	"""Report the outcome of a scheduled run to lucos_schedule_tracker.
+
+	Args:
+		success: Whether the job completed successfully.
+		system: Identifier of the calling system. 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.
+			Defaults to 86400 (24 hours). Pass your cron's actual interval —
+			schedule-tracker uses this to derive its alert threshold. Do not
+			adjust this value to manipulate the threshold; if the resulting
+			alert window is wrong for your job, raise it as a schedule-tracker
+			issue rather than passing a misleading value here.
+	"""
 	payload = {
 		"system": system,
 		"frequency": frequency,