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

label_studio_sdk-1.0.2/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.1
+Name: label-studio-sdk
+Version: 1.0.2
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: Pillow (>=10.0.1)
+Requires-Dist: appdirs (>=1.4.3)
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: ijson (>=3.2.3)
+Requires-Dist: jsonschema (==3.2.0)
+Requires-Dist: lxml (>=4.2.5)
+Requires-Dist: nltk (==3.6.7)
+Requires-Dist: pandas (>=0.24.0)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: requests (>=2.22.0)
+Requires-Dist: requests-mock (==1.12.1)
+Requires-Dist: typing_extensions (>=4.0.0)
+Requires-Dist: ujson (>=5.8.0)
+Requires-Dist: xmljson (==0.2.1)
+Description-Content-Type: text/markdown
+
+# 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)
+[![pypi](https://img.shields.io/pypi/v/label-studio-sdk.svg)](https://pypi.python.org/pypi/label-studio-sdk)
+
+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
+# or
+poetry add 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",
+)
+```
+
+## Advanced
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from label_studio_sdk.client import LabelStudio
+
+ls = LabelStudio(
+    # All timeouts set to 20 seconds
+    timeout=20.0
+)
+
+ls.projects.create(..., {
+    # Override timeout for a specific method
+    timeout=20.0
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from label_studio_sdk.client import LabelStudio
+
+ls = LabelStudio(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+<!-- 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.2/README.md

@@ -0,0 +1,158 @@
+# 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)
+[![pypi](https://img.shields.io/pypi/v/label-studio-sdk.svg)](https://pypi.python.org/pypi/label-studio-sdk)
+
+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
+# or
+poetry add 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",
+)
+```
+
+## Advanced
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from label_studio_sdk.client import LabelStudio
+
+ls = LabelStudio(
+    # All timeouts set to 20 seconds
+    timeout=20.0
+)
+
+ls.projects.create(..., {
+    # Override timeout for a specific method
+    timeout=20.0
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from label_studio_sdk.client import LabelStudio
+
+ls = LabelStudio(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+<!-- 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.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "label-studio-sdk"
-version = "1.0.0"
+version = "1.0.2"
 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.2}/src/label_studio_sdk/__init__.py

@@ -4,6 +4,8 @@ from .types import (
     Annotation,
     AnnotationFilterOptions,
     AnnotationLastAction,
+    AnnotationsDmField,
+    AnnotationsDmFieldLastAction,
     AzureBlobExportStorage,
     AzureBlobExportStorageStatus,
     AzureBlobImportStorage,
@@ -12,6 +14,9 @@ from .types import (
     BaseUser,
     ConvertedFormat,
     ConvertedFormatStatus,
+    DataManagerTaskSerializer,
+    DataManagerTaskSerializerDraftsItem,
+    DataManagerTaskSerializerPredictionsItem,
     Export,
     ExportConvert,
     ExportCreate,
@@ -73,6 +78,19 @@ from . import (
     webhooks,
 )
 from ._legacy import Client
+from .actions import (
+    ActionsCreateRequestFilters,
+    ActionsCreateRequestFiltersConjunction,
+    ActionsCreateRequestFiltersItemsItem,
+    ActionsCreateRequestFiltersItemsItemFilter,
+    ActionsCreateRequestFiltersItemsItemOperator,
+    ActionsCreateRequestFiltersItemsItemValue,
+    ActionsCreateRequestId,
+    ActionsCreateRequestOrderingItem,
+    ActionsCreateRequestSelectedItems,
+    ActionsCreateRequestSelectedItemsExcluded,
+    ActionsCreateRequestSelectedItemsIncluded,
+)
 from .environment import LabelStudioEnvironment
 from .export_storage import ExportStorageListTypesResponseItem
 from .import_storage import ImportStorageListTypesResponseItem
@@ -93,21 +111,38 @@ from .views import (
     ViewsCreateRequestDataFilters,
     ViewsCreateRequestDataFiltersConjunction,
     ViewsCreateRequestDataFiltersItemsItem,
+    ViewsCreateRequestDataFiltersItemsItemFilter,
+    ViewsCreateRequestDataFiltersItemsItemOperator,
+    ViewsCreateRequestDataFiltersItemsItemValue,
     ViewsCreateRequestDataOrderingItem,
-    ViewsCreateRequestDataOrderingItemDirection,
     ViewsUpdateRequestData,
     ViewsUpdateRequestDataFilters,
     ViewsUpdateRequestDataFiltersConjunction,
     ViewsUpdateRequestDataFiltersItemsItem,
+    ViewsUpdateRequestDataFiltersItemsItemFilter,
+    ViewsUpdateRequestDataFiltersItemsItemOperator,
+    ViewsUpdateRequestDataFiltersItemsItemValue,
     ViewsUpdateRequestDataOrderingItem,
-    ViewsUpdateRequestDataOrderingItemDirection,
 )
 from .webhooks import WebhooksUpdateRequestActionsItem
 
 __all__ = [
+    "ActionsCreateRequestFilters",
+    "ActionsCreateRequestFiltersConjunction",
+    "ActionsCreateRequestFiltersItemsItem",
+    "ActionsCreateRequestFiltersItemsItemFilter",
+    "ActionsCreateRequestFiltersItemsItemOperator",
+    "ActionsCreateRequestFiltersItemsItemValue",
+    "ActionsCreateRequestId",
+    "ActionsCreateRequestOrderingItem",
+    "ActionsCreateRequestSelectedItems",
+    "ActionsCreateRequestSelectedItemsExcluded",
+    "ActionsCreateRequestSelectedItemsIncluded",
     "Annotation",
     "AnnotationFilterOptions",
     "AnnotationLastAction",
+    "AnnotationsDmField",
+    "AnnotationsDmFieldLastAction",
     "AzureBlobExportStorage",
     "AzureBlobExportStorageStatus",
     "AzureBlobImportStorage",
@@ -118,6 +153,9 @@ __all__ = [
     "Client",
     "ConvertedFormat",
     "ConvertedFormatStatus",
+    "DataManagerTaskSerializer",
+    "DataManagerTaskSerializerDraftsItem",
+    "DataManagerTaskSerializerPredictionsItem",
     "Export",
     "ExportConvert",
     "ExportCreate",
@@ -179,14 +217,18 @@ __all__ = [
     "ViewsCreateRequestDataFilters",
     "ViewsCreateRequestDataFiltersConjunction",
     "ViewsCreateRequestDataFiltersItemsItem",
+    "ViewsCreateRequestDataFiltersItemsItemFilter",
+    "ViewsCreateRequestDataFiltersItemsItemOperator",
+    "ViewsCreateRequestDataFiltersItemsItemValue",
     "ViewsCreateRequestDataOrderingItem",
-    "ViewsCreateRequestDataOrderingItemDirection",
     "ViewsUpdateRequestData",
     "ViewsUpdateRequestDataFilters",
     "ViewsUpdateRequestDataFiltersConjunction",
     "ViewsUpdateRequestDataFiltersItemsItem",
+    "ViewsUpdateRequestDataFiltersItemsItemFilter",
+    "ViewsUpdateRequestDataFiltersItemsItemOperator",
+    "ViewsUpdateRequestDataFiltersItemsItemValue",
     "ViewsUpdateRequestDataOrderingItem",
-    "ViewsUpdateRequestDataOrderingItemDirection",
     "Webhook",
     "WebhookActionsItem",
     "WebhookSerializerForUpdate",

label_studio_sdk-1.0.2/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.0 → label_studio_sdk-1.0.2}/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.2/src/label_studio_sdk/actions/__init__.py

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