lucos-schedule-tracker-pythonclient 1.0.0__tar.gz → 1.0.2__tar.gz

lucos_schedule_tracker_pythonclient-1.0.2/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: lucos_schedule_tracker_pythonclient
+Version: 1.0.2
+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.2/README.md

@@ -0,0 +1,33 @@
+# 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.2/lucos_schedule_tracker_pythonclient.egg-info/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: lucos_schedule_tracker_pythonclient
+Version: 1.0.2
+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.0 → lucos_schedule_tracker_pythonclient-1.0.2}/pyproject.toml

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

lucos_schedule_tracker_pythonclient-1.0.0/PKG-INFO

@@ -1,11 +0,0 @@
-Metadata-Version: 2.4
-Name: lucos_schedule_tracker_pythonclient
-Version: 1.0.0
-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

lucos_schedule_tracker_pythonclient-1.0.0/README.md

@@ -1,2 +0,0 @@
-# lucos_schedule_tracker_pythonclient
-Python library for sending updates to lucos_schedule_tracker

lucos_schedule_tracker_pythonclient-1.0.0/lucos_schedule_tracker_pythonclient.egg-info/PKG-INFO

@@ -1,11 +0,0 @@
-Metadata-Version: 2.4
-Name: lucos_schedule_tracker_pythonclient
-Version: 1.0.0
-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