label-studio-sdk 0.0.27__tar.gz → 0.0.29__tar.gz

{label-studio-sdk-0.0.27/label_studio_sdk.egg-info → label-studio-sdk-0.0.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: label-studio-sdk
-Version: 0.0.27
+Version: 0.0.29
 Summary: Label Studio annotation tool
 Home-page: https://github.com/heartexlabs/label-studio-sdk
 Author: Heartex

{label-studio-sdk-0.0.27 → label-studio-sdk-0.0.29}/README.md

@@ -17,7 +17,7 @@ If you want to take action not supported natively by the SDK, you can [call the
 This is the first release of the Label Studio SDK. It supports Label Studio Enterprise, Label Studio Teams, and Label Studio Community.
 
 - **Find a bug?** [Create a GitHub issue](https://github.com/heartexlabs/label-studio-sdk/issues)!
-- **Have a question?** [Join the Slack Community](https://slack.labelstudio.heartex.com/?source=github-sdk)!
+- **Have a question?** [Join the Slack Community](https://slack.labelstud.io/?source=github-sdk)!
 - **Want to contribute?** [See the contributing guide](https://github.com/heartexlabs/label-studio-sdk/CONTRIBUTING.md)
 
 ## Quickstart
@@ -43,6 +43,10 @@ The Label Studio SDK includes the following:
 
 For all the details, see the [reference documentation](https://labelstud.io/sdk) or [review the code directly](https://github.com/heartexlabs/label-studio-sdk/tree/master/label_studio_sdk). 
 
+## Error logging
+
+To see error logs, you can use `stderr` (we use `logger.error()` for error output). If you use console to run SDK commands, you will see all errors there. 
+
 ## Contribute to the SDK
 
 If you want to extend the SDK:

{label-studio-sdk-0.0.27 → label-studio-sdk-0.0.29}/label_studio_sdk/__init__.py

@@ -5,4 +5,4 @@ from .project import Project
 from .utils import parse_config
 
 
-__version__ = '0.0.27'
+__version__ = '0.0.29'

{label-studio-sdk-0.0.27 → label-studio-sdk-0.0.29}/label_studio_sdk/client.py

@@ -1,5 +1,6 @@
 """ .. include::../docs/client.md
 """
+import json
 import warnings
 import logging
 import requests
@@ -7,11 +8,12 @@ import requests
 from typing import Optional
 from pydantic import BaseModel, constr, root_validator
 from requests.adapters import HTTPAdapter
+from types import SimpleNamespace
 
 logger = logging.getLogger(__name__)
 
 MAX_RETRIES = 3
-TIMEOUT = (1.0, 180.0)
+TIMEOUT = (10.0, 180.0)
 HEADERS = {}
 
 
@@ -42,7 +44,7 @@ class Client(object):
         cookies: dict = None,
         oidc_token=None,
         versions=None,
-        make_request_raise=True
+        make_request_raise=True,
     ):
         """Initialize the client. Do this before using other Label Studio SDK classes and methods in your script.
 
@@ -95,7 +97,6 @@ class Client(object):
         self.versions = versions if versions else self.get_versions()
         self.is_enterprise = 'label-studio-enterprise-backend' in self.versions
 
-
     def get_versions(self):
         """Call /version api and get all Label Studio component versions
 
@@ -259,7 +260,7 @@ class Client(object):
             users.append(User(**user_data))
         return users
 
-    def create_user(self, user):
+    def create_user(self, user, exist_ok=True):
         """Create a new user
 
         Parameters
@@ -267,6 +268,8 @@ class Client(object):
         user: User or dict
             User instance, you can initialize it this way:
             User(username='x', email='x@x.xx', first_name='X', last_name='Z')
+        exist_ok: bool
+            True by default, it won't print error if user exists and exist_ok=True
 
         Returns
         -------
@@ -278,7 +281,7 @@ class Client(object):
 
         payload = (
             {
-                'username': user.username,
+                'username': user.username if user.username else user.email,
                 'email': user.email,
                 'first_name': user.first_name,
                 'last_name': user.last_name,
@@ -288,13 +291,16 @@ class Client(object):
             else user
         )
 
-        try:
-            response = self.make_request('POST', '/api/users', json=payload)
-            user_data = response.json()
-            user_data['client'] = self
+        response = self.make_request('POST', '/api/users', json=payload, raise_exceptions=False)
+        user_data = response.json()
+        user_data['client'] = self
+
+        if response.status_code < 400:
             return User(**user_data)
-        except requests.HTTPError as e:
-            logger.error('Create user error:' + str(e.response.json()))
+        else:
+            if 'already exists' in response.text and exist_ok is True:
+                return None
+            logger.error('Create user error: ' + str(response.json()))
             return None
 
     def get_workspaces(self):
@@ -367,6 +373,11 @@ class Client(object):
         """
         if 'timeout' not in kwargs:
             kwargs['timeout'] = TIMEOUT
+
+        raise_exceptions = self.make_request_raise
+        if 'raise_exceptions' in kwargs:  # kwargs have higher priority
+            raise_exceptions = kwargs.pop('raise_exceptions')
+
         logger.debug(f'{method}: {url} with args={args}, kwargs={kwargs}')
         response = self.session.request(
             method,
@@ -376,8 +387,22 @@ class Client(object):
             *args,
             **kwargs,
         )
-        if self.make_request_raise:
-            response.raise_for_status()
+
+        if raise_exceptions:
+            if response.status_code >= 400:
+                try:
+                    content = json.dumps(json.loads(response.content), indent=2)
+                except:
+                    content = response.text
+
+                logger.error(
+                    f'\n--------------------------------------------\n'
+                    f'Request URL: {response.url}\n'
+                    f'Response status code: {response.status_code}\n'
+                    f'Response content:\n{content}\n\n'
+                    f'SDK error traceback:')
+                response.raise_for_status()
+
         return response
 
     def sync_storage(self, storage_type, storage_id):

{label-studio-sdk-0.0.27 → label-studio-sdk-0.0.29}/label_studio_sdk/project.py

@@ -4,6 +4,7 @@ import os
 import json
 import logging
 import pathlib
+import time
 
 from enum import Enum, auto
 from random import sample, shuffle
@@ -447,7 +448,7 @@ class Project(Client):
             session=client.session,
             extra_headers=client.headers,
             versions=client.versions,
-            make_request_raise=client.make_request_raise
+            make_request_raise=client.make_request_raise,
         )
         if params and isinstance(params, dict):
             # TODO: validate project parameters
@@ -518,7 +519,37 @@ class Project(Client):
             raise TypeError(
                 f'Not supported type provided as "tasks" argument: {type(tasks)}'
             )
-        return response.json()['task_ids']
+        response = response.json()
+
+        if 'import' in response:
+            # check import status
+            timeout = 300
+            fibonacci_backoff = [1, 1]
+
+            start_time = time.time()
+
+            while True:
+                import_status = self.make_request(
+                    method='GET',
+                    url=f'/api/projects/{self.id}/imports/{response["import"]}',
+                ).json()
+
+                if import_status['status'] == 'completed':
+                    return import_status['task_ids']
+
+                if import_status['status'] == 'failed':
+                    raise LabelStudioException(import_status['error'])
+
+                if time.time() - start_time >= timeout:
+                    raise LabelStudioException('Import timeout')
+
+                time.sleep(fibonacci_backoff[0])
+                fibonacci_backoff = [
+                    fibonacci_backoff[1],
+                    fibonacci_backoff[0] + fibonacci_backoff[1],
+                ]
+
+        return response['task_ids']
 
     def export_tasks(
         self,

{label-studio-sdk-0.0.27 → label-studio-sdk-0.0.29/label_studio_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: label-studio-sdk
-Version: 0.0.27
+Version: 0.0.29
 Summary: Label Studio annotation tool
 Home-page: https://github.com/heartexlabs/label-studio-sdk
 Author: Heartex

{label-studio-sdk-0.0.27 → label-studio-sdk-0.0.29}/label_studio_sdk.egg-info/SOURCES.txt

@@ -17,4 +17,5 @@ label_studio_sdk.egg-info/dependency_links.txt
 label_studio_sdk.egg-info/requires.txt
 label_studio_sdk.egg-info/top_level.txt
 tests/__init__.py
+tests/import_test.py
 tests/test_client.py

label-studio-sdk-0.0.29/tests/import_test.py

@@ -0,0 +1,35 @@
+LABEL_STUDIO_URL = 'https://fb-lsdv-5218.dev.heartex.com'
+API_KEY = 'aaf73cc7ac1e681212a9919d99e907965a32ff37'
+
+# Import the SDK and the client module
+from label_studio_sdk import Client
+
+# Connect to the Label Studio API and check the connection
+ls = Client(url=LABEL_STUDIO_URL, api_key=API_KEY)
+ls.check_connection()
+
+project = ls.start_project(
+    title='Image Project',
+    label_config='''
+    <View>
+
+      <Header value="Select label and click the image to start"/>
+      <Image name="image" value="$image" zoom="true"/>
+
+      <PolygonLabels name="label" toName="image"
+                     strokeWidth="3" pointSize="small"
+                     opacity="0.9">
+        <Label value="Airplane" background="red"/>
+        <Label value="Car" background="blue"/>
+      </PolygonLabels>
+
+    </View>
+    '''
+)
+
+project.import_tasks(
+    [
+        {'image': 'https://data.heartex.net/open-images/train_0/mini/0045dd96bf73936c.jpg'},
+        {'image': 'https://data.heartex.net/open-images/train_0/mini/0083d02f6ad18b38.jpg'}
+    ]
+)