Add 'set_task_metadata', associated test, and example in README

README.rst

@@ -271,6 +271,24 @@ __ https://docs.scale.com/reference/delete-task-unique-id
     task.clear_unique_id()
 
 
+Set A Task's Metadata
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set a given task's ``metadata``. Check out `Scale's API documentation`__ for more information.
+
+__ https://docs.scale.com/reference/set-metadata
+
+.. code-block :: python
+
+    # set metadata on a task by specifying task id
+    new_metadata = {'myKey': 'myValue'}
+    task = client.set_task_metadata('30553edd0b6a93f8f05f0fee', new_metadata)
+
+    # set metadata on a task object
+    task = client.get_task('30553edd0b6a93f8f05f0fee')
+    new_metadata = {'myKey': 'myValue'}
+    task.set_metadata(new_metadata)
+
 Batches
 _______
 

scaleapi/__init__.py

@@ -114,6 +114,21 @@ def clear_task_unique_id(self, task_id: str) -> Task:
         endpoint = f"task/{task_id}/unique_id"
         return Task(self.api.delete_request(endpoint), self)
 
+    def set_task_metadata(self, task_id: str, metadata: Dict) -> Task:
+        """Sets a task's metadata and returns the associated task.
+
+        Args:
+            task_id (str):
+                Task id
+            metadata (Dict):
+                metadata to set
+
+        Returns:
+            Task
+        """
+        endpoint = f"task/{task_id}/setMetadata"
+        return Task(self.api.post_request(endpoint, body=metadata), self)
+
     def tasks(self, **kwargs) -> Tasklist:
         """Returns a list of your tasks.
         Returns up to 100 at a time, to get more, use the

scaleapi/_version.py

@@ -1,2 +1,2 @@
-__version__ = "2.9.0"
+__version__ = "2.10.0"
 __package_name__ = "scaleapi"

scaleapi/tasks.py

@@ -95,3 +95,7 @@ def update_unique_id(self, unique_id: str):
     def clear_unique_id(self):
         """Clears unique_id of a task"""
         self._client.clear_task_unique_id(self.id)
+
+    def set_metadata(self, metadata: dict):
+        """Sets the metadata of a task"""
+        self._client.set_task_metadata(self.id, metadata)

tests/test_client.py

@@ -93,6 +93,25 @@ def test_clear_unique_id():
     assert "unique_id" not in task.as_dict()
 
 
+def test_set_metadata():
+    unique_id = str(uuid.uuid4())
+    original_task = make_a_task(unique_id)
+    new_metadata = {"myKey": "myValue"}
+    updated_task = client.set_task_metadata(original_task.id, new_metadata)
+    assert original_task.metadata == {}
+    assert updated_task.metadata == new_metadata
+
+
+def test_task_set_metadata():
+    unique_id = str(uuid.uuid4())
+    task = make_a_task(unique_id)
+    assert task.metadata == {}
+    new_metadata = {"fromTaskKey": "fromTaskValue"}
+    task.set_metadata(new_metadata)
+    task.refresh()
+    assert task.metadata == new_metadata
+
+
 def test_categorize_ok():
     client.create_task(
         TaskType.Categorization,
@@ -169,7 +188,6 @@ def test_imageannotation_fail():
 def test_documenttranscription_ok():
     client.create_task(
         TaskType.DocumentTranscription,
-        callback_url="http://www.example.com/callback",
         instruction="Please transcribe this receipt.",
         attachment="http://document.scale.com/receipt-20200519.jpg",
         features=[{"type": "block", "label": "barcode"}],