add Slice raw export method (#187)

* add Slice raw export method

* bump ver; update changelog

* add test

* isort

Author: drakejwong

CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to the [Nucleus Python Client](https://github.com/scaleapi/n
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.4](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.4.4) - 2021-01-04
+
+### Added
+- `Slice.export_raw_items()` method that fetches accessible (signed) URLs for all items in the Slice.
+
+## [0.4.3](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.4.3) - 2022-01-03
+
+### Added
+- Improved error messages for categorization
+
+### Changed
+- Category taxonomies are now updatable
+
 ## [0.4.2](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.4.2) - 2021-12-16
 
 ### Added

nucleus/slice.py

@@ -280,6 +280,29 @@ def export_embeddings(
         )
         return api_payload
 
+    def export_raw_items(self) -> List[Dict[str, str]]:
+        """Fetches a list of accessible URLs for each item in the Slice.
+
+        Returns:
+            List where each element is a dict containing a DatasetItem and its
+            accessible (signed) Scale URL.
+            ::
+
+                List[{
+                    "id": str,
+                    "ref_id": str,
+                    "metadata": Dict[str, Union[str, int]],
+                    "original_url": str,
+                    "scale_url": str
+                }]
+        """
+        api_payload = self._client.make_request(
+            payload=None,
+            route=f"slice/{self.id}/exportRawItems",
+            requests_command=requests.get,
+        )
+        return api_payload
+
 
 def check_annotations_are_in_slice(
     annotations: List[Annotation], slice_to_check: Slice

pyproject.toml

@@ -21,7 +21,7 @@ exclude = '''
 
 [tool.poetry]
 name = "scale-nucleus"
-version = "0.4.3"
+version = "0.4.4"
 description = "The official Python client library for Nucleus, the Data Platform for AI"
 license =  "MIT"
 authors = ["Scale AI Nucleus Team <nucleusapi@scaleapi.com>"]

tests/test_slice.py

@@ -1,6 +1,7 @@
 import copy
 
 import pytest
+import requests
 
 from nucleus import BoxAnnotation, Dataset, DatasetItem, NucleusClient, Slice
 from nucleus.constants import (
@@ -189,3 +190,31 @@ def test_slice_send_to_labeling(dataset):
 
     response = slc.send_to_labeling(TEST_PROJECT_ID)
     assert isinstance(response, AsyncJob)
+
+
+def test_slice_export_raw_items(dataset):
+    # Dataset upload
+    orig_url = TEST_IMG_URLS[0]
+    ds_items = [
+        DatasetItem(
+            image_location=orig_url,
+            reference_id=reference_id_from_url(orig_url),
+        )
+    ]
+    response = dataset.append(ds_items)
+    assert ERROR_PAYLOAD not in response.json()
+
+    # Slice creation
+    slc = dataset.create_slice(
+        name=(TEST_SLICE_NAME + "-raw-export"),
+        reference_ids=[ds_items[0].reference_id],
+    )
+
+    # Export single raw item
+    res = slc.export_raw_items()
+    export_url = res["raw_dataset_items"][0]["scale_url"]
+
+    orig_bytes = requests.get(orig_url).content
+    export_bytes = requests.get(export_url).content
+
+    assert hash(orig_bytes) == hash(export_bytes)