Merge pull request #134 from Labelbox/rodion/export_issues

Add an ability to export issues in SDK

Author: Rodion Yaryy

labelbox/schema/project.py

@@ -177,6 +177,40 @@ def export_labels(self, timeout_seconds=60):
                          self.uid)
             time.sleep(sleep_time)
 
+    def export_issues(self, status=None):
+        """ Calls the server-side Issues exporting that 
+        returns the URL to that payload.
+
+        Args:
+            status (string): valid values: Open, Resolved
+        Returns:
+            URL of the data file with this Project's issues. 
+        """
+        id_param = "projectId"
+        status_param = "status"
+        query_str = """query GetProjectIssuesExportPyApi($%s: ID!, $%s: IssueStatus) {
+            project(where: { id: $%s }) {
+                issueExportUrl(where: { status: $%s })
+            }
+        }""" % (id_param, status_param, id_param, status_param)
+
+        valid_statuses = {None, "Open", "Resolved"}
+
+        if status not in valid_statuses:
+            raise ValueError("status must be in {}. Found {}".format(
+                valid_statuses, status))
+
+        res = self.client.execute(query_str, {
+            id_param: self.uid,
+            status_param: status
+        })
+
+        res = res['project']
+
+        logger.debug("Project '%s' issues export, link generated", self.uid)
+
+        return res.get('issueExportUrl')
+
     def upsert_instructions(self, instructions_file: str):
         """
         * Uploads instructions to the UI. Running more than once will replace the instructions

tests/integration/test_issues.py

@@ -0,0 +1,20 @@
+import pytest
+
+
+def test_issues_export(project):
+    exported_issues_url = project.export_issues()
+    assert exported_issues_url
+
+    exported_issues_url = project.export_issues("Open")
+    assert exported_issues_url
+    assert "?status=Open" in exported_issues_url
+
+    exported_issues_url = project.export_issues("Resolved")
+    assert exported_issues_url
+    assert "?status=Resolved" in exported_issues_url
+
+    invalidStatusValue = "Closed"
+    with pytest.raises(ValueError) as exc_info:
+        exported_issues_url = project.export_issues(invalidStatusValue)
+    assert "status must be in" in str(exc_info.value)
+    assert "Found %s" % (invalidStatusValue) in str(exc_info.value)