label-studio-sdk 1.0.0__tar.gz → 1.0.1__tar.gz

{label_studio_sdk-1.0.0 → label_studio_sdk-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: label-studio-sdk
-Version: 1.0.0
+Version: 1.0.1
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers
@@ -65,63 +65,36 @@ The Label Studio Python Library provides convenient access to the Label Studio A
 
 <!-- Outline -->
 
-- [Installation](#installation)
-- [Usage](#usage)
-- [Examples](#examples)
-  - [Get all projects](#get-all-projects)
-  - [Create a new project](#create-a-new-project)
-  - [Get project by ID](#get-project-by-id)
-  - [Update project](#update-project)
-  - [Delete project](#delete-project)
-  - [Get tasks with annotations and predictions](#get-tasks-with-annotations-and-predictions)
-  - [Get task by ID](#get-task-by-id)
-  - [Get all annotations for a task](#get-all-annotations-for-a-task)
-  - [Create a new task](#create-a-new-task)
-  - [Import batch tasks](#import-batch-tasks)
-  - [Update task](#update-task)
-  - [Delete task](#delete-task)
-  - [Create prediction](#create-prediction)
-  - [Update prediction](#update-prediction)
-  - [Delete prediction](#delete-prediction)
-  - [Async client](#async-client)
-
 
 # Documentation
-Explore the Label Studio API documentation [here](https://label-studio.docs.buildwithfern.com/).
+Explore the Label Studio API documentation [here](https://api.labelstud.io/).
 
 
-<!-- Begin Installation, generated by Fern  -->
 # Installation
 
 ```sh
 pip install --upgrade label-studio-sdk
 ```
-<!-- End Installation  -->
 
-<!-- Begin Usage, generated by Fern  -->
 # Usage
 
 ```python
 from label_studio_sdk.client import LabelStudio
 
-client = LabelStudio(
+ls = LabelStudio(
+    base_url='YOUR_LABEL_STUDIO_URL',  
     api_key="YOUR_API_KEY",
 )
 ```
-<!-- End Usage  -->
 
 # Examples
 
-## Get all projects
-
-```python
-projects = client.projects.list()
-```
+Check more examples [here](https://api.labelstud.io/).
 
 ## Create a new project
 
 ```python
-project = client.projects.create(
+project = ls.projects.create(
     name="Project name",
     description="Project description",
     label_config="""
@@ -136,143 +109,26 @@ project = client.projects.create(
 )
 ```
 
-## Get project by ID
-
-```python
-project = client.projects.get("PROJECT_ID")
-```
-
-## Update project
-
-```python
-project = client.projects.update(
-    project="PROJECT_ID",
-    description="New project description",
-)
-```
-
-## Delete project
-
-```python
-client.projects.delete("PROJECT_ID")
-```
-
-## Get tasks with annotations and predictions
-
-```python
-tasks = client.tasks.list(project="PROJECT_ID")
-```
-
-## Get task by ID
-
-```python
-task = client.tasks.get("TASK_ID")
-print(task)
-```
-Task data, annotations and predictions in [Label Studio tasks format](https://labelstud.io/guide/task_format#Label-Studio-JSON-format-of-annotated-tasks):
-```json
-{
-    "id": "TASK_ID",
-    "data": {
-        "image": "https://example.com/image.jpg",
-        "label": "cat"
-    },
-    "annotations": [],
-    "predictions": []
-}
-```
-
-## Get all annotations for a task
-
-```python
-annotations = client.annotations.list(task="TASK_ID")
-```
-
 ## Create a new task
-
-```python
-task = client.tasks.create(
-    project="PROJECT_ID",
-    data={
-        "data": {
-            "image": "https://example.com/image.jpg",
-            "label": "cat"
-        }
-    }
-)
-```
-
-## Import batch tasks
-
-```python
-tasks = client.projects.import_tasks(
-    project="PROJECT_ID",
-    data=[
-        {
-            "data": {
-                "image": "https://example.com/image1.jpg",
-                "label": "cat"
-            }
-        },
-        {
-            "data": {
-                "image": "https://example.com/image2.jpg",
-                "label": "dog"
-            }
-        }
-    ]
-)
-```
-
-## Update task
-
+    
 ```python
-task = client.tasks.update(
-    project="PROJECT_ID",
-    task="TASK_ID",
-    data={
-        "data": {
-            "image": "https://example.com/image.jpg",
-            "label": "dog"
-        }
-    }
+task = ls.tasks.create(
+    project=project.id,
+    data={"image": "https://example.com/image.jpg"}
 )
 ```
+Now you can open the project `PROJECT_ID` in the Label Studio UI and create annotations for the task.
 
-## Delete task
+## Export annotations
 
 ```python
-client.tasks.delete(project="PROJECT_ID", task="TASK_ID")
+annotations = [
+    task.annotations
+    for task in ls.tasks.list(project=project.id, fields='all')
+    if task.annotations
+]
 ```
 
-## Create prediction
-
-```python
-prediction = client.predictions.create(
-    task="TASK_ID",
-    result=[{'from_name': 'bbox', 'to_name': 'image', 'type': 'labels', 'value': {'rectanglelabels': [{'x': 10, 'y': 20, 'width': 30, 'height': 40, 'rectanglelabels': ['cat']}]}}],
-    score=0.9,
-    model_version='yolov8',
-)
-```
-
-## Update prediction
-
-```python
-prediction = client.predictions.update(
-    task="TASK_ID",
-    prediction="PREDICTION_ID",
-    result=[{'from_name': 'bbox', 'to_name': 'image', 'type': 'labels', 'value': {'rectanglelabels': [{'x': 10, 'y': 20, 'width': 30, 'height': 40, 'rectanglelabels': ['dog']}]}}],
-    score=0.8,
-    model_version='yolov8',
-)
-```
-
-## Delete prediction
-
-```python
-client.predictions.delete(task="TASK_ID", prediction="PREDICTION_ID")
-```
 
 ## Async client
 

label_studio_sdk-1.0.1/README.md

@@ -0,0 +1,126 @@
+# Label Studio Python Library
+
+<!-- Note about deprecated version <1 -->
+---
+> :warning: **Note**<br/>
+>
+> The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
+> If you still want to use the old version, you can install it with `pip install "label-studio-sdk<1"`.
+> OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
+>
+> ```sh
+> git clone https://github.com/HumanSignal/label-studio-sdk.git
+> cd label-studio-sdk
+> git checkout previous-version
+> ```
+> 
+> OR you can change your import statements as follows:
+> ```python
+> from label_studio_sdk import Client
+> from label_studio_sdk.data_manager import Filters, Column, Operator, Type
+> from label_studio_sdk._legacy import Project
+> ```
+---
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+
+The Label Studio Python Library provides convenient access to the Label Studio API from applications written in Python.
+<!-- End Title  -->
+
+<!-- Outline -->
+
+
+# Documentation
+Explore the Label Studio API documentation [here](https://api.labelstud.io/).
+
+
+# Installation
+
+```sh
+pip install --upgrade label-studio-sdk
+```
+
+# Usage
+
+```python
+from label_studio_sdk.client import LabelStudio
+
+ls = LabelStudio(
+    base_url='YOUR_LABEL_STUDIO_URL',  
+    api_key="YOUR_API_KEY",
+)
+```
+
+# Examples
+
+Check more examples [here](https://api.labelstud.io/).
+
+## Create a new project
+
+```python
+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>
+    """
+)
+```
+
+## Create a new task
+    
+```python
+task = ls.tasks.create(
+    project=project.id,
+    data={"image": "https://example.com/image.jpg"}
+)
+```
+Now you can open the project `PROJECT_ID` in the Label Studio UI and create annotations for the task.
+
+## Export annotations
+
+```python
+annotations = [
+    task.annotations
+    for task in ls.tasks.list(project=project.id, fields='all')
+    if task.annotations
+]
+```
+
+
+## Async client
+
+```python
+from label_studio_sdk.client import AsyncLabelStudio
+
+client = AsyncLabelStudio(
+    api_key="YOUR_API_KEY",
+)
+```
+
+<!-- Begin Status, generated by Fern  -->
+# Beta Status
+
+This SDK is in beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.
+<!-- End Status  -->
+
+<!-- Begin Contributing, generated by Fern  -->
+# Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+<!-- End Contributing  -->
+

{label_studio_sdk-1.0.0 → label_studio_sdk-1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "label-studio-sdk"
-version = "1.0.0"
+version = "1.0.1"
 description = ""
 readme = "README.md"
 authors = []
@@ -48,7 +48,7 @@ ujson = ">=5.8.0"
 xmljson = "0.2.1"
 
 [tool.poetry.dev-dependencies]
-mypy = "1.9.0"
+mypy = "1.0.1"
 pytest = "^7.4.0"
 pytest-asyncio = "^0.23.5"
 python-dateutil = "^2.9.0"

{label_studio_sdk-1.0.0 → label_studio_sdk-1.0.1}/src/label_studio_sdk/__init__.py

@@ -73,6 +73,18 @@ from . import (
     webhooks,
 )
 from ._legacy import Client
+from .actions import (
+    ActionsCreateRequestFilters,
+    ActionsCreateRequestFiltersConjunction,
+    ActionsCreateRequestFiltersItemsItem,
+    ActionsCreateRequestFiltersItemsItemFilter,
+    ActionsCreateRequestFiltersItemsItemOperator,
+    ActionsCreateRequestId,
+    ActionsCreateRequestOrderingItem,
+    ActionsCreateRequestSelectedItems,
+    ActionsCreateRequestSelectedItemsExcluded,
+    ActionsCreateRequestSelectedItemsIncluded,
+)
 from .environment import LabelStudioEnvironment
 from .export_storage import ExportStorageListTypesResponseItem
 from .import_storage import ImportStorageListTypesResponseItem
@@ -93,18 +105,30 @@ from .views import (
     ViewsCreateRequestDataFilters,
     ViewsCreateRequestDataFiltersConjunction,
     ViewsCreateRequestDataFiltersItemsItem,
+    ViewsCreateRequestDataFiltersItemsItemFilter,
+    ViewsCreateRequestDataFiltersItemsItemOperator,
     ViewsCreateRequestDataOrderingItem,
-    ViewsCreateRequestDataOrderingItemDirection,
     ViewsUpdateRequestData,
     ViewsUpdateRequestDataFilters,
     ViewsUpdateRequestDataFiltersConjunction,
     ViewsUpdateRequestDataFiltersItemsItem,
+    ViewsUpdateRequestDataFiltersItemsItemFilter,
+    ViewsUpdateRequestDataFiltersItemsItemOperator,
     ViewsUpdateRequestDataOrderingItem,
-    ViewsUpdateRequestDataOrderingItemDirection,
 )
 from .webhooks import WebhooksUpdateRequestActionsItem
 
 __all__ = [
+    "ActionsCreateRequestFilters",
+    "ActionsCreateRequestFiltersConjunction",
+    "ActionsCreateRequestFiltersItemsItem",
+    "ActionsCreateRequestFiltersItemsItemFilter",
+    "ActionsCreateRequestFiltersItemsItemOperator",
+    "ActionsCreateRequestId",
+    "ActionsCreateRequestOrderingItem",
+    "ActionsCreateRequestSelectedItems",
+    "ActionsCreateRequestSelectedItemsExcluded",
+    "ActionsCreateRequestSelectedItemsIncluded",
     "Annotation",
     "AnnotationFilterOptions",
     "AnnotationLastAction",
@@ -179,14 +203,16 @@ __all__ = [
     "ViewsCreateRequestDataFilters",
     "ViewsCreateRequestDataFiltersConjunction",
     "ViewsCreateRequestDataFiltersItemsItem",
+    "ViewsCreateRequestDataFiltersItemsItemFilter",
+    "ViewsCreateRequestDataFiltersItemsItemOperator",
     "ViewsCreateRequestDataOrderingItem",
-    "ViewsCreateRequestDataOrderingItemDirection",
     "ViewsUpdateRequestData",
     "ViewsUpdateRequestDataFilters",
     "ViewsUpdateRequestDataFiltersConjunction",
     "ViewsUpdateRequestDataFiltersItemsItem",
+    "ViewsUpdateRequestDataFiltersItemsItemFilter",
+    "ViewsUpdateRequestDataFiltersItemsItemOperator",
     "ViewsUpdateRequestDataOrderingItem",
-    "ViewsUpdateRequestDataOrderingItemDirection",
     "Webhook",
     "WebhookActionsItem",
     "WebhookSerializerForUpdate",

label_studio_sdk-1.0.1/src/label_studio_sdk/_extensions/pager_ext.py

@@ -0,0 +1,49 @@
+import typing
+from label_studio_sdk.core.pagination import SyncPager, AsyncPager, T
+from label_studio_sdk.core.api_error import ApiError
+
+# This is a custom extension of the autogenerated SyncPager and AsyncPager classes
+# that works with the Label Studio SDK's default pagination behavior
+# that throws 404 errors at the end of the pagination.
+
+
+class SyncPagerExt(SyncPager, typing.Generic[T]):
+
+    @classmethod
+    def from_sync_pager(cls, sync_pager: SyncPager) -> 'SyncPagerExt':
+        return cls(
+            get_next=sync_pager.get_next,
+            has_next=sync_pager.has_next,
+            items=sync_pager.items
+        )
+
+    def __iter__(self) -> typing.Iterator[T]:  # type: ignore
+        # Extends the iterator to catch 404 errors at the end of the pagination
+        try:
+            for item in super().__iter__():
+                yield item
+        except ApiError as exc:
+            if exc.status_code == 404:
+                return
+            raise
+
+
+class AsyncPagerExt(AsyncPager, typing.Generic[T]):
+
+    @classmethod
+    async def from_async_pager(cls, async_pager: AsyncPager) -> 'AsyncPagerExt':
+        return cls(
+            get_next=async_pager.get_next,
+            has_next=async_pager.has_next,
+            items=async_pager.items
+        )
+
+    async def __aiter__(self) -> typing.AsyncIterator[T]:  # type: ignore
+        # Extends the iterator to catch 404 errors at the end of the pagination
+        try:
+            async for item in super().__aiter__():
+                yield item
+        except ApiError as exc:
+            if exc.status_code == 404:
+                return
+            raise

label_studio_sdk-1.0.1/src/label_studio_sdk/_legacy/objects.py

@@ -0,0 +1,74 @@
+from typing import Type, Dict, Optional, List, Tuple, Any, Union
+from pydantic import BaseModel, Field, confloat
+
+from label_studio_sdk.label_interface.region import Region
+
+
+def serialize_regions(result):
+    """ """
+    res = []
+    relations = []
+    for r in result:
+        if isinstance(r, Region):
+            res.append(r._dict())
+            if r.has_relations:
+                relations.append(r._dict_relations())
+        else:
+            res.append(r)
+
+    return res + relations
+
+
+class PredictionValue(BaseModel):
+    """ """
+
+    model_version: Optional[Any] = None
+    score: Optional[float] = 0.00
+    result: Optional[List[Union[Dict[str, Any], Region]]]
+    # cluster: Optional[Any] = None
+    # neighbors: Optional[Any] = None
+
+    class Config:
+        allow_population_by_field_name = True
+
+    def serialize(self):
+        """ """
+        return {
+            "model_version": self.model_version,
+            "score": self.score,
+            "result": serialize_regions(self.result),
+        }
+
+
+class AnnotationValue(BaseModel):
+    """ """
+    
+    was_cancelled: Optional[bool] = False
+    ground_truth: Optional[bool] = False
+    lead_time: Optional[float] = 0.0
+    result_count: Optional[int] = 0
+    completed_by: int
+
+    result: Optional[List[Union[Dict[str, Any], Region]]]
+    
+    class Config:
+        allow_population_by_field_name = True
+
+    def serialize(self):
+        """ """
+        return {
+            "was_cancelled": self.was_cancelled,
+            "ground_truth": self.ground_truth,
+            "lead_time": self.lead_time,
+            "result_count": self.result_count,
+            "completed_by": self.completed_by,
+            "result": serialize_regions(self.result),
+        }
+
+
+class TaskValue(BaseModel):
+    """ """
+    
+    data: Optional[dict]
+    annotations: Optional[List[AnnotationValue]]
+    predictions: Optional[List[PredictionValue]]

{label_studio_sdk-1.0.0 → label_studio_sdk-1.0.1}/src/label_studio_sdk/_legacy/schema/label_config_schema.json

@@ -37,19 +37,19 @@
     },
     "tag_with_value_required_name": {
       "type": "object",
-      "oneOf": [
-          {
-            "required": [
-                "@name",
-                "@value"
-            ]
-          },
-          {
-            "required": [
-                "@name",
-                "@valueList"
-            ]
-          }
+      "anyOf": [
+	{
+          "required": [
+            "@name",
+            "@valueList"
+          ]
+        },
+        {
+          "required": [
+            "@name",
+            "@value"
+          ]
+        }
       ],
       "properties": {
         "@value": {
@@ -223,4 +223,4 @@
       }
     }
   }
-}
+}

label_studio_sdk-1.0.1/src/label_studio_sdk/actions/__init__.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    ActionsCreateRequestFilters,
+    ActionsCreateRequestFiltersConjunction,
+    ActionsCreateRequestFiltersItemsItem,
+    ActionsCreateRequestFiltersItemsItemFilter,
+    ActionsCreateRequestFiltersItemsItemOperator,
+    ActionsCreateRequestId,
+    ActionsCreateRequestOrderingItem,
+    ActionsCreateRequestSelectedItems,
+    ActionsCreateRequestSelectedItemsExcluded,
+    ActionsCreateRequestSelectedItemsIncluded,
+)
+
+__all__ = [
+    "ActionsCreateRequestFilters",
+    "ActionsCreateRequestFiltersConjunction",
+    "ActionsCreateRequestFiltersItemsItem",
+    "ActionsCreateRequestFiltersItemsItemFilter",
+    "ActionsCreateRequestFiltersItemsItemOperator",
+    "ActionsCreateRequestId",
+    "ActionsCreateRequestOrderingItem",
+    "ActionsCreateRequestSelectedItems",
+    "ActionsCreateRequestSelectedItemsExcluded",
+    "ActionsCreateRequestSelectedItemsIncluded",
+]