labeltify 0.2.0__tar.gz → 0.3.0__tar.gz

{labeltify-0.2.0 → labeltify-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labeltify
-Version: 0.2.0
+Version: 0.3.0
 Summary: Upload frames and optional annotations into LabelTify with a pipeline token.
 Author: CleverTify
 Project-URL: Homepage, https://labeltify.com
@@ -46,7 +46,7 @@ client.upload_file("DATASET_ID", "frames/cam02.jpg", camera="cam-02")
 
 The token knows its org, so you don't pass one. Timeouts, `429`, and `5xx` responses are retried with exponential backoff (`max_retries=4` by default). Anything else raises `LabelTifyError` with the API's message and `.status`.
 
-Annotations are optional. Pass `labels` (COCO, LabelTify, or YOLO JSON bytes) and `work_state` (`done`, `in_progress`, `unsure`, or `untouched`). Images with no labels stay untouched. If labels are sent and `work_state` is omitted, those images are marked Done.
+Annotations are optional. When you pass `labels` (COCO, LabelTify, or YOLO JSON bytes), `work_state` is required: `done`, `in_progress`, `unsure`, or `untouched`. There is no default; the client raises `LabelTifyError` before sending if it is missing. Images with no labels stay untouched.
 
 Send model proposals to the Loop review queue:
 

{labeltify-0.2.0 → labeltify-0.3.0}/README.md

@@ -27,7 +27,7 @@ client.upload_file("DATASET_ID", "frames/cam02.jpg", camera="cam-02")
 
 The token knows its org, so you don't pass one. Timeouts, `429`, and `5xx` responses are retried with exponential backoff (`max_retries=4` by default). Anything else raises `LabelTifyError` with the API's message and `.status`.
 
-Annotations are optional. Pass `labels` (COCO, LabelTify, or YOLO JSON bytes) and `work_state` (`done`, `in_progress`, `unsure`, or `untouched`). Images with no labels stay untouched. If labels are sent and `work_state` is omitted, those images are marked Done.
+Annotations are optional. When you pass `labels` (COCO, LabelTify, or YOLO JSON bytes), `work_state` is required: `done`, `in_progress`, `unsure`, or `untouched`. There is no default; the client raises `LabelTifyError` before sending if it is missing. Images with no labels stay untouched.
 
 Send model proposals to the Loop review queue:
 

{labeltify-0.2.0 → labeltify-0.3.0}/labeltify/client.py

@@ -23,6 +23,7 @@ from pathlib import Path
 from typing import Any
 
 DEFAULT_BASE_URL = "https://api.labeltify.com"
+WORK_STATES = ("done", "in_progress", "unsure", "untouched")
 RETRY_STATUS = {408, 425, 429, 500, 502, 503, 504}
 
 
@@ -122,7 +123,12 @@ class LabelTifyClient:
         labels_filename: str = "labels.json",
         work_state: str | None = None,
     ) -> dict[str, Any]:
-        """Upload one image. ``labels`` is optional COCO, LabelTify, or YOLO JSON for it."""
+        """Upload one image. ``labels`` is optional COCO, LabelTify, or YOLO JSON for it.
+
+        With ``labels``, ``work_state`` is required: done, in_progress, unsure, or untouched.
+        """
+        if labels is not None and work_state not in WORK_STATES:
+            raise LabelTifyError(f"work_state is required with labels: one of {', '.join(WORK_STATES)}")
         boundary = f"----labeltify{uuid.uuid4().hex}"
         parts: list[bytes] = []
 

{labeltify-0.2.0 → labeltify-0.3.0}/labeltify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labeltify
-Version: 0.2.0
+Version: 0.3.0
 Summary: Upload frames and optional annotations into LabelTify with a pipeline token.
 Author: CleverTify
 Project-URL: Homepage, https://labeltify.com
@@ -46,7 +46,7 @@ client.upload_file("DATASET_ID", "frames/cam02.jpg", camera="cam-02")
 
 The token knows its org, so you don't pass one. Timeouts, `429`, and `5xx` responses are retried with exponential backoff (`max_retries=4` by default). Anything else raises `LabelTifyError` with the API's message and `.status`.
 
-Annotations are optional. Pass `labels` (COCO, LabelTify, or YOLO JSON bytes) and `work_state` (`done`, `in_progress`, `unsure`, or `untouched`). Images with no labels stay untouched. If labels are sent and `work_state` is omitted, those images are marked Done.
+Annotations are optional. When you pass `labels` (COCO, LabelTify, or YOLO JSON bytes), `work_state` is required: `done`, `in_progress`, `unsure`, or `untouched`. There is no default; the client raises `LabelTifyError` before sending if it is missing. Images with no labels stay untouched.
 
 Send model proposals to the Loop review queue:
 

{labeltify-0.2.0 → labeltify-0.3.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "labeltify"
 # Bump this to publish. .github/workflows/publish-python.yml releases each new version pushed to main.
-version = "0.2.0"
+version = "0.3.0"
 description = "Upload frames and optional annotations into LabelTify with a pipeline token."
 readme = "README.md"
 requires-python = ">=3.10"

{labeltify-0.2.0 → labeltify-0.3.0}/tests/test_client.py

@@ -125,3 +125,13 @@ def test_propose(api):
     task = client.propose("ds-1", "img-1", [{"classId": "car"}], model_ref="deepstream@1")
     assert task["echo"]["modelRef"] == "deepstream@1"
     assert api.requests[-1][1] == "/api/orgs/acme/datasets/ds-1/al/tasks"
+
+
+def test_labels_need_a_work_state(api):
+    client = LabelTifyClient("labeltify_test", base_url=api.url, org="acme", backoff=0)
+    before = len(api.requests)
+    with pytest.raises(LabelTifyError, match="work_state is required"):
+        client.upload_image("ds-1", b"x", "a.jpg", labels=b'{"images": []}')
+    with pytest.raises(LabelTifyError, match="work_state is required"):
+        client.upload_image("ds-1", b"x", "a.jpg", labels=b'{"images": []}', work_state="skipped")
+    assert len(api.requests) == before