label-studio-sdk 1.0.2__tar.gz → 1.0.4__tar.gz

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: label-studio-sdk
-Version: 1.0.2
+Version: 1.0.4
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
@@ -47,12 +47,13 @@ Description-Content-Type: text/markdown
 > ```sh
 > git clone https://github.com/HumanSignal/label-studio-sdk.git
 > cd label-studio-sdk
-> git checkout previous-version
+> git fetch origin
+> git checkout release/0.0.34
 > ```
 > 
 > OR you can change your import statements as follows:
 > ```python
-> from label_studio_sdk import Client
+> from label_studio_sdk._legacy import Client
 > from label_studio_sdk.data_manager import Filters, Column, Operator, Type
 > from label_studio_sdk._legacy import Project
 > ```
@@ -97,18 +98,16 @@ Check more examples [here](https://api.labelstud.io/).
 ## Create a new project
 
 ```python
+from label_studio_sdk.label_interface import LabelInterface
+from label_studio_sdk.label_interface.create import labels
+
 project = ls.projects.create(
     name="Project name",
     description="Project description",
-    label_config="""
-    <View>
-        <Image name="image" value="$image" />
-        <RectangleLabels name="label" toName="image">
-            <Label value="cat" />
-            <Label value="dog" />
-        </RectangleLabels>
-    </View>
-    """
+    label_config=LabelInterface.create({
+      "image": "Image",
+      "bbox": labels(["cat", "dog"], tag_type="RectangleLabels")
+    })
 )
 ```
 

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/README.md

@@ -11,12 +11,13 @@
 > ```sh
 > git clone https://github.com/HumanSignal/label-studio-sdk.git
 > cd label-studio-sdk
-> git checkout previous-version
+> git fetch origin
+> git checkout release/0.0.34
 > ```
 > 
 > OR you can change your import statements as follows:
 > ```python
-> from label_studio_sdk import Client
+> from label_studio_sdk._legacy import Client
 > from label_studio_sdk.data_manager import Filters, Column, Operator, Type
 > from label_studio_sdk._legacy import Project
 > ```
@@ -61,18 +62,16 @@ Check more examples [here](https://api.labelstud.io/).
 ## Create a new project
 
 ```python
+from label_studio_sdk.label_interface import LabelInterface
+from label_studio_sdk.label_interface.create import labels
+
 project = ls.projects.create(
     name="Project name",
     description="Project description",
-    label_config="""
-    <View>
-        <Image name="image" value="$image" />
-        <RectangleLabels name="label" toName="image">
-            <Label value="cat" />
-            <Label value="dog" />
-        </RectangleLabels>
-    </View>
-    """
+    label_config=LabelInterface.create({
+      "image": "Image",
+      "bbox": labels(["cat", "dog"], tag_type="RectangleLabels")
+    })
 )
 ```
 

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "label-studio-sdk"
-version = "1.0.2"
+version = "1.0.4"
 description = ""
 readme = "README.md"
 authors = []

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/src/label_studio_sdk/__init__.py

@@ -11,10 +11,13 @@ from .types import (
     AzureBlobImportStorage,
     AzureBlobImportStorageStatus,
     BaseTask,
+    BaseTaskFileUpload,
+    BaseTaskUpdatedBy,
     BaseUser,
     ConvertedFormat,
     ConvertedFormatStatus,
     DataManagerTaskSerializer,
+    DataManagerTaskSerializerAnnotatorsItem,
     DataManagerTaskSerializerDraftsItem,
     DataManagerTaskSerializerPredictionsItem,
     Export,
@@ -51,9 +54,13 @@ from .types import (
     S3ExportStorageStatus,
     S3ImportStorage,
     S3ImportStorageStatus,
+    S3SExportStorage,
+    S3SImportStorage,
+    S3SImportStorageStatus,
     SerializationOption,
     SerializationOptions,
     Task,
+    TaskAnnotatorsItem,
     TaskFilterOptions,
     UserSimple,
     View,
@@ -61,6 +68,7 @@ from .types import (
     WebhookActionsItem,
     WebhookSerializerForUpdate,
     WebhookSerializerForUpdateActionsItem,
+    Workspace,
 )
 from .errors import BadRequestError, InternalServerError
 from . import (
@@ -76,6 +84,7 @@ from . import (
     users,
     views,
     webhooks,
+    workspaces,
 )
 from ._legacy import Client
 from .actions import (
@@ -102,7 +111,7 @@ from .ml import (
     MlUpdateResponse,
     MlUpdateResponseAuthMethod,
 )
-from .projects import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse
+from .projects import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse, ProjectsUpdateResponse
 from .tasks import TasksListRequestFields, TasksListResponse
 from .users import UsersGetTokenResponse, UsersResetTokenResponse
 from .version import __version__
@@ -149,11 +158,14 @@ __all__ = [
     "AzureBlobImportStorageStatus",
     "BadRequestError",
     "BaseTask",
+    "BaseTaskFileUpload",
+    "BaseTaskUpdatedBy",
     "BaseUser",
     "Client",
     "ConvertedFormat",
     "ConvertedFormatStatus",
     "DataManagerTaskSerializer",
+    "DataManagerTaskSerializerAnnotatorsItem",
     "DataManagerTaskSerializerDraftsItem",
     "DataManagerTaskSerializerPredictionsItem",
     "Export",
@@ -195,6 +207,7 @@ __all__ = [
     "ProjectsCreateResponse",
     "ProjectsImportTasksResponse",
     "ProjectsListResponse",
+    "ProjectsUpdateResponse",
     "RedisExportStorage",
     "RedisExportStorageStatus",
     "RedisImportStorage",
@@ -203,9 +216,13 @@ __all__ = [
     "S3ExportStorageStatus",
     "S3ImportStorage",
     "S3ImportStorageStatus",
+    "S3SExportStorage",
+    "S3SImportStorage",
+    "S3SImportStorageStatus",
     "SerializationOption",
     "SerializationOptions",
     "Task",
+    "TaskAnnotatorsItem",
     "TaskFilterOptions",
     "TasksListRequestFields",
     "TasksListResponse",
@@ -234,6 +251,7 @@ __all__ = [
     "WebhookSerializerForUpdate",
     "WebhookSerializerForUpdateActionsItem",
     "WebhooksUpdateRequestActionsItem",
+    "Workspace",
     "__version__",
     "actions",
     "annotations",
@@ -247,4 +265,5 @@ __all__ = [
     "users",
     "views",
     "webhooks",
+    "workspaces",
 ]

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/src/label_studio_sdk/actions/client.py

@@ -44,9 +44,9 @@ class ActionsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/dm/actions/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -134,9 +134,9 @@ class ActionsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -172,9 +172,9 @@ class AsyncActionsClient:
         _response = await self._client_wrapper.httpx_client.request(
             "api/dm/actions/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -262,9 +262,9 @@ class AsyncActionsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/src/label_studio_sdk/annotations/client.py

@@ -51,9 +51,9 @@ class AnnotationsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/annotations/{jsonable_encoder(id)}/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -93,9 +93,9 @@ class AnnotationsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/annotations/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -182,7 +182,7 @@ class AnnotationsClient:
                         "width": 50,
                         "height": 60,
                         "rotation": 0,
-                        "values": {"rectanglelabels": {"0": "Person"}},
+                        "values": {"rectanglelabels": ["Person"]},
                     },
                 }
             ],
@@ -206,9 +206,9 @@ class AnnotationsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -247,9 +247,9 @@ class AnnotationsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/tasks/{jsonable_encoder(id)}/annotations/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.List[Annotation], _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(typing.List[Annotation], _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -348,7 +348,7 @@ class AnnotationsClient:
                         "width": 50,
                         "height": 60,
                         "rotation": 0,
-                        "values": {"rectanglelabels": {"0": "Person"}},
+                        "values": {"rectanglelabels": ["Person"]},
                     },
                 }
             ],
@@ -372,9 +372,9 @@ class AnnotationsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -418,9 +418,9 @@ class AsyncAnnotationsClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/annotations/{jsonable_encoder(id)}/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -460,9 +460,9 @@ class AsyncAnnotationsClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/annotations/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -549,7 +549,7 @@ class AsyncAnnotationsClient:
                         "width": 50,
                         "height": 60,
                         "rotation": 0,
-                        "values": {"rectanglelabels": {"0": "Person"}},
+                        "values": {"rectanglelabels": ["Person"]},
                     },
                 }
             ],
@@ -573,9 +573,9 @@ class AsyncAnnotationsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -616,9 +616,9 @@ class AsyncAnnotationsClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/tasks/{jsonable_encoder(id)}/annotations/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.List[Annotation], _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(typing.List[Annotation], _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -717,7 +717,7 @@ class AsyncAnnotationsClient:
                         "width": 50,
                         "height": 60,
                         "rotation": 0,
-                        "values": {"rectanglelabels": {"0": "Person"}},
+                        "values": {"rectanglelabels": ["Person"]},
                     },
                 }
             ],
@@ -741,9 +741,9 @@ class AsyncAnnotationsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(Annotation, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/src/label_studio_sdk/base_client.py

@@ -20,6 +20,7 @@ from .tasks.client import AsyncTasksClient, TasksClient
 from .users.client import AsyncUsersClient, UsersClient
 from .views.client import AsyncViewsClient, ViewsClient
 from .webhooks.client import AsyncWebhooksClient, WebhooksClient
+from .workspaces.client import AsyncWorkspacesClient, WorkspacesClient
 
 
 class LabelStudioBase:
@@ -96,6 +97,7 @@ class LabelStudioBase:
         self.import_storage = ImportStorageClient(client_wrapper=self._client_wrapper)
         self.export_storage = ExportStorageClient(client_wrapper=self._client_wrapper)
         self.webhooks = WebhooksClient(client_wrapper=self._client_wrapper)
+        self.workspaces = WorkspacesClient(client_wrapper=self._client_wrapper)
 
 
 class AsyncLabelStudioBase:
@@ -172,6 +174,7 @@ class AsyncLabelStudioBase:
         self.import_storage = AsyncImportStorageClient(client_wrapper=self._client_wrapper)
         self.export_storage = AsyncExportStorageClient(client_wrapper=self._client_wrapper)
         self.webhooks = AsyncWebhooksClient(client_wrapper=self._client_wrapper)
+        self.workspaces = AsyncWorkspacesClient(client_wrapper=self._client_wrapper)
 
 
 def _get_base_url(*, base_url: typing.Optional[str] = None, environment: LabelStudioEnvironment) -> str:

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/src/label_studio_sdk/core/client_wrapper.py

@@ -17,7 +17,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "label-studio-sdk",
-            "X-Fern-SDK-Version": "1.0.2",
+            "X-Fern-SDK-Version": "1.0.4",
         }
         headers["Authorization"] = f"Token  {self.api_key}"
         return headers

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/src/label_studio_sdk/core/http_client.py

@@ -2,6 +2,7 @@
 
 import asyncio
 import email.utils
+import json
 import re
 import time
 import typing
@@ -125,6 +126,25 @@ def maybe_filter_request_body(
     return data_content
 
 
+# Abstracted out for testing purposes
+def get_request_body(
+    *,
+    json: typing.Optional[typing.Any],
+    data: typing.Optional[typing.Any],
+    request_options: typing.Optional[RequestOptions],
+    omit: typing.Optional[typing.Any],
+) -> typing.Tuple[typing.Optional[typing.Any], typing.Optional[typing.Any]]:
+    json_body = None
+    data_body = None
+    if data is not None:
+        data_body = maybe_filter_request_body(data, request_options, omit)
+    else:
+        # If both data and json are None, we send json data in the event extra properties are specified
+        json_body = maybe_filter_request_body(json, request_options, omit)
+
+    return json_body, data_body
+
+
 class HttpClient:
     def __init__(
         self,
@@ -168,6 +188,8 @@ class HttpClient:
             else self.base_timeout
         )
 
+        json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
+
         response = self.httpx_client.request(
             method=method,
             url=urllib.parse.urljoin(f"{base_url}/", path),
@@ -197,8 +219,8 @@ class HttpClient:
                     )
                 )
             ),
-            json=maybe_filter_request_body(json, request_options, omit),
-            data=maybe_filter_request_body(data, request_options, omit),
+            json=json_body,
+            data=data_body,
             content=content,
             files=convert_file_dict_to_httpx_tuples(remove_none_from_dict(files)) if files is not None else None,
             timeout=timeout,
@@ -248,6 +270,8 @@ class HttpClient:
             else self.base_timeout
         )
 
+        json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
+
         with self.httpx_client.stream(
             method=method,
             url=urllib.parse.urljoin(f"{base_url}/", path),
@@ -277,8 +301,8 @@ class HttpClient:
                     )
                 )
             ),
-            json=maybe_filter_request_body(json, request_options, omit),
-            data=maybe_filter_request_body(data, request_options, omit),
+            json=json_body,
+            data=data_body,
             content=content,
             files=convert_file_dict_to_httpx_tuples(remove_none_from_dict(files)) if files is not None else None,
             timeout=timeout,
@@ -329,6 +353,8 @@ class AsyncHttpClient:
             else self.base_timeout
         )
 
+        json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
+
         # Add the input to each of these and do None-safety checks
         response = await self.httpx_client.request(
             method=method,
@@ -359,8 +385,8 @@ class AsyncHttpClient:
                     )
                 )
             ),
-            json=maybe_filter_request_body(json, request_options, omit),
-            data=maybe_filter_request_body(data, request_options, omit),
+            json=json_body,
+            data=data_body,
             content=content,
             files=convert_file_dict_to_httpx_tuples(remove_none_from_dict(files)) if files is not None else None,
             timeout=timeout,
@@ -409,6 +435,8 @@ class AsyncHttpClient:
             else self.base_timeout
         )
 
+        json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
+
         async with self.httpx_client.stream(
             method=method,
             url=urllib.parse.urljoin(f"{base_url}/", path),
@@ -438,8 +466,8 @@ class AsyncHttpClient:
                     )
                 )
             ),
-            json=maybe_filter_request_body(json, request_options, omit),
-            data=maybe_filter_request_body(data, request_options, omit),
+            json=json_body,
+            data=data_body,
             content=content,
             files=convert_file_dict_to_httpx_tuples(remove_none_from_dict(files)) if files is not None else None,
             timeout=timeout,

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/src/label_studio_sdk/core/request_options.py

@@ -5,10 +5,10 @@ import typing
 try:
     from typing import NotRequired  # type: ignore
 except ImportError:
-    from typing_extensions import NotRequired  # type: ignore
+    from typing_extensions import NotRequired
 
 
-class RequestOptions(typing.TypedDict):
+class RequestOptions(typing.TypedDict, total=False):
     """
     Additional options for request-specific configuration when calling APIs via the SDK.
     This is used primarily as an optional final parameter for service functions.

{label_studio_sdk-1.0.2 → label_studio_sdk-1.0.4}/src/label_studio_sdk/export_storage/__init__.py

@@ -1,7 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .types import ExportStorageListTypesResponseItem
-from . import azure, gcs, local, redis, s3
+from . import azure, gcs, local, redis, s3, s3s
 from .azure import AzureCreateResponse, AzureUpdateResponse
 from .gcs import GcsCreateResponse, GcsUpdateResponse
 from .local import LocalCreateResponse, LocalUpdateResponse
@@ -25,4 +25,5 @@ __all__ = [
     "local",
     "redis",
     "s3",
+    "s3s",
 ]