label-studio-sdk 2.0.8__tar.gz → 2.0.9__tar.gz

{label_studio_sdk-2.0.8 → label_studio_sdk-2.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 2.0.8
+Version: 2.0.9
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers
@@ -69,9 +69,9 @@ poetry add label-studio-sdk
 # Usage
 
 ```python
-from label_studio_sdk.client import LabelStudio
+from label_studio_sdk import LabelStudio
 
-ls = LabelStudio(
+client = LabelStudio(
     base_url='YOUR_LABEL_STUDIO_URL',  
     api_key="YOUR_API_KEY",
 )
@@ -148,105 +148,56 @@ from label_studio_sdk._legacy import Project
 
 </details>
 
-# Examples
-
-Check more examples [here](https://api.labelstud.io/).
-
-## Create a new project
+# Example: Create a new project with tasks
 
 ```python
-from label_studio_sdk.label_interface import LabelInterface
-from label_studio_sdk.label_interface.create import labels
-
-project = ls.projects.create(
-    title="Project name",
-    description="Project description",
-    label_config=LabelInterface.create({
-      "image": "Image",
-      "bbox": labels(["cat", "dog"], tag_type="RectangleLabels")
-    })
-)
-```
+# Import the SDK and the client module
+from label_studio_sdk import LabelStudio
 
-## Create a new task
-    
-```python
-task = ls.tasks.create(
-    project=project.id,
-    data={"image": "https://example.com/image.jpg"}
+client = LabelStudio(
+    base_url="http://localhost:8080",   # <-- put your LS URL here
+    api_key="YOUR_API_KEY",             # <-- put your API key here
 )
-```
-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",
+label_config = """
+<View>
+  <Header value="Choose text sentiment:"/>
+  <Text name="text" value="$text"/>
+  <Choices name="sentiment" toName="text" choice="single">
+    <Choice value="Positive"/>
+    <Choice value="Negative"/>
+    <Choice value="Neutral"/>
+  </Choices>
+</View>
+"""
+
+# Create project
+project = client.projects.create(
+    title="Sentiment Classification",
+    label_config=label_config
 )
-```
 
-## Advanced
+# (Optional) validate the config to catch mistakes early
+client.projects.validate_label_config(id=project.id, label_config=label_config)
 
-### 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
+# Create a single task
+task = client.tasks.create(
+    project=project.id,
+    data={"text": "Label Studio is the best!"}  # 'text' matches value="$text"
 )
-
-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"),
-    ),
+print(f"Created task id: {task.id}")
+
+# Or create multiple tasks at once
+client.projects.import_tasks(
+    id=project.id,
+    request=[
+        {"text": "I love Label Studio"},
+        {"text": "Label Studio helps me ship faster"},
+    ]
 )
 ```
 
-## Enterprise features
-
-### Create comments
-    
-```python
-comment = ls.comments.create(
-    project=project.id,
-    annotation=annotation.id,
-    text="Comment text"
-)
-```
+For additional examples, see [our API reference](https://api.labelstud.io/). 
 
 <!-- Begin Contributing, generated by Fern  -->
 # Contributing

{label_studio_sdk-2.0.8 → label_studio_sdk-2.0.9}/README.md

@@ -24,9 +24,9 @@ poetry add label-studio-sdk
 # Usage
 
 ```python
-from label_studio_sdk.client import LabelStudio
+from label_studio_sdk import LabelStudio
 
-ls = LabelStudio(
+client = LabelStudio(
     base_url='YOUR_LABEL_STUDIO_URL',  
     api_key="YOUR_API_KEY",
 )
@@ -103,105 +103,56 @@ from label_studio_sdk._legacy import Project
 
 </details>
 
-# Examples
-
-Check more examples [here](https://api.labelstud.io/).
-
-## Create a new project
+# Example: Create a new project with tasks
 
 ```python
-from label_studio_sdk.label_interface import LabelInterface
-from label_studio_sdk.label_interface.create import labels
-
-project = ls.projects.create(
-    title="Project name",
-    description="Project description",
-    label_config=LabelInterface.create({
-      "image": "Image",
-      "bbox": labels(["cat", "dog"], tag_type="RectangleLabels")
-    })
-)
-```
+# Import the SDK and the client module
+from label_studio_sdk import LabelStudio
 
-## Create a new task
-    
-```python
-task = ls.tasks.create(
-    project=project.id,
-    data={"image": "https://example.com/image.jpg"}
+client = LabelStudio(
+    base_url="http://localhost:8080",   # <-- put your LS URL here
+    api_key="YOUR_API_KEY",             # <-- put your API key here
 )
-```
-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",
+label_config = """
+<View>
+  <Header value="Choose text sentiment:"/>
+  <Text name="text" value="$text"/>
+  <Choices name="sentiment" toName="text" choice="single">
+    <Choice value="Positive"/>
+    <Choice value="Negative"/>
+    <Choice value="Neutral"/>
+  </Choices>
+</View>
+"""
+
+# Create project
+project = client.projects.create(
+    title="Sentiment Classification",
+    label_config=label_config
 )
-```
 
-## Advanced
+# (Optional) validate the config to catch mistakes early
+client.projects.validate_label_config(id=project.id, label_config=label_config)
 
-### 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
+# Create a single task
+task = client.tasks.create(
+    project=project.id,
+    data={"text": "Label Studio is the best!"}  # 'text' matches value="$text"
 )
-
-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"),
-    ),
+print(f"Created task id: {task.id}")
+
+# Or create multiple tasks at once
+client.projects.import_tasks(
+    id=project.id,
+    request=[
+        {"text": "I love Label Studio"},
+        {"text": "Label Studio helps me ship faster"},
+    ]
 )
 ```
 
-## Enterprise features
-
-### Create comments
-    
-```python
-comment = ls.comments.create(
-    project=project.id,
-    annotation=annotation.id,
-    text="Comment text"
-)
-```
+For additional examples, see [our API reference](https://api.labelstud.io/). 
 
 <!-- Begin Contributing, generated by Fern  -->
 # Contributing

{label_studio_sdk-2.0.8 → label_studio_sdk-2.0.9}/pyproject.toml

@@ -3,7 +3,7 @@ name = "label-studio-sdk"
 
 [tool.poetry]
 name = "label-studio-sdk"
-version = "2.0.8"
+version = "2.0.9"
 description = ""
 readme = "README.md"
 authors = []

{label_studio_sdk-2.0.8 → label_studio_sdk-2.0.9}/src/label_studio_sdk/__init__.py

@@ -35,19 +35,23 @@ from .types import (
     BillingFlags,
     BillingInfoResponse,
     BlankEnum,
-    Blueprint,
     BlueprintList,
     BudgetResetPeriodEnum,
+    CancelModelRunResponse,
     ChildFilter,
     Comment,
     CommentRequest,
     CommentSerializerWithExpandedUser,
     ConfigurablePermissionOption,
-    ConfigurablePermissionOptionDefault,
     ConvertedFormat,
     ConvertedFormatRequest,
     CountLimit,
     CustomScriptsEditableByEnum,
+    DatabricksExportStorage,
+    DatabricksExportStorageRequest,
+    DatabricksImportStorage,
+    DatabricksImportStorageRequest,
+    Default165Enum,
     DefaultRole,
     DefaultRoleCustomScriptsEditableBy,
     EditionEnum,
@@ -86,6 +90,9 @@ from .types import (
     LseProjectCreate,
     LseProjectCreateSampling,
     LseProjectCreateSkipQueue,
+    LseProjectResponse,
+    LseProjectResponseSampling,
+    LseProjectResponseSkipQueue,
     LseProjectSampling,
     LseProjectSkipQueue,
     LseProjectUpdate,
@@ -134,6 +141,7 @@ from .types import (
     ModelRunStatusEnum,
     NullEnum,
     OnboardingStateEnum,
+    Options165Enum,
     OrganizationBilling,
     OrganizationId,
     OrganizationInvite,
@@ -148,12 +156,12 @@ from .types import (
     PaginatedLseUserList,
     PaginatedPaginatedProjectMemberList,
     PaginatedProjectMember,
+    PaginatedProjectSubsetTasksResponseList,
     PaginatedRoleBasedTaskList,
     Pause,
     PauseRequest,
     Prediction,
     PredictionRequest,
-    Project,
     ProjectGroup,
     ProjectGroupRequest,
     ProjectGroupRoleEnum,
@@ -161,9 +169,10 @@ from .types import (
     ProjectLabelConfig,
     ProjectLabelConfigRequest,
     ProjectMemberBulkAssignRolesRequest,
-    ProjectSampling,
-    ProjectSkipQueue,
     ProjectSubsetEnum,
+    ProjectSubsetItem,
+    ProjectSubsetTaskItem,
+    ProjectSubsetTasksResponse,
     ProjectTemplate,
     ProjectTemplateRequest,
     PromptsStatusEnum,
@@ -178,8 +187,11 @@ from .types import (
     ReviewSettingsRequest,
     ReviewSettingsRequestRequeueRejectedTasksMode,
     ReviewSettingsRequestReviewCriteria,
+    ReviewSettingsRequestSampling,
     ReviewSettingsRequeueRejectedTasksMode,
     ReviewSettingsReviewCriteria,
+    ReviewSettingsSampling,
+    ReviewSettingsSamplingEnum,
     ReviewedEnum,
     Role9E7Enum,
     RoleBasedTask,
@@ -187,7 +199,7 @@ from .types import (
     S3ImportStorage,
     SamlSettings,
     SamlSettingsUpdate,
-    SamplingEnum,
+    SamplingDe5Enum,
     ScimSettings,
     ScimSettingsUpdate,
     ScopeEnum,
@@ -240,7 +252,6 @@ from . import (
     annotation_reviews,
     annotations,
     billing,
-    blueprints,
     comments,
     export_storage,
     files,
@@ -297,7 +308,6 @@ from .projects import (
     ProjectsDuplicateResponse,
     ProjectsImportPredictionsResponse,
     ProjectsImportTasksResponse,
-    ProjectsListRequestFilter,
 )
 from .prompts import PromptsCompatibleProjectsRequestProjectType
 from .tasks import TasksListRequestFields
@@ -394,20 +404,24 @@ __all__ = [
     "BillingFlags",
     "BillingInfoResponse",
     "BlankEnum",
-    "Blueprint",
     "BlueprintList",
     "BudgetResetPeriodEnum",
+    "CancelModelRunResponse",
     "ChildFilter",
     "Client",
     "Comment",
     "CommentRequest",
     "CommentSerializerWithExpandedUser",
     "ConfigurablePermissionOption",
-    "ConfigurablePermissionOptionDefault",
     "ConvertedFormat",
     "ConvertedFormatRequest",
     "CountLimit",
     "CustomScriptsEditableByEnum",
+    "DatabricksExportStorage",
+    "DatabricksExportStorageRequest",
+    "DatabricksImportStorage",
+    "DatabricksImportStorageRequest",
+    "Default165Enum",
     "DefaultRole",
     "DefaultRoleCustomScriptsEditableBy",
     "EditionEnum",
@@ -454,6 +468,9 @@ __all__ = [
     "LseProjectCreateRequestSkipQueue",
     "LseProjectCreateSampling",
     "LseProjectCreateSkipQueue",
+    "LseProjectResponse",
+    "LseProjectResponseSampling",
+    "LseProjectResponseSkipQueue",
     "LseProjectSampling",
     "LseProjectSkipQueue",
     "LseProjectUpdate",
@@ -508,6 +525,7 @@ __all__ = [
     "NotFoundError",
     "NullEnum",
     "OnboardingStateEnum",
+    "Options165Enum",
     "OrganizationBilling",
     "OrganizationId",
     "OrganizationInvite",
@@ -522,6 +540,7 @@ __all__ = [
     "PaginatedLseUserList",
     "PaginatedPaginatedProjectMemberList",
     "PaginatedProjectMember",
+    "PaginatedProjectSubsetTasksResponseList",
     "PaginatedRoleBasedTaskList",
     "PatchedDefaultRoleRequestCustomScriptsEditableBy",
     "PatchedLseProjectUpdateRequestSampling",
@@ -530,7 +549,6 @@ __all__ = [
     "PauseRequest",
     "Prediction",
     "PredictionRequest",
-    "Project",
     "ProjectGroup",
     "ProjectGroupRequest",
     "ProjectGroupRoleEnum",
@@ -538,15 +556,15 @@ __all__ = [
     "ProjectLabelConfig",
     "ProjectLabelConfigRequest",
     "ProjectMemberBulkAssignRolesRequest",
-    "ProjectSampling",
-    "ProjectSkipQueue",
     "ProjectSubsetEnum",
+    "ProjectSubsetItem",
+    "ProjectSubsetTaskItem",
+    "ProjectSubsetTasksResponse",
     "ProjectTemplate",
     "ProjectTemplateRequest",
     "ProjectsDuplicateResponse",
     "ProjectsImportPredictionsResponse",
     "ProjectsImportTasksResponse",
-    "ProjectsListRequestFilter",
     "PromptsCompatibleProjectsRequestProjectType",
     "PromptsStatusEnum",
     "ProviderEnum",
@@ -560,8 +578,11 @@ __all__ = [
     "ReviewSettingsRequest",
     "ReviewSettingsRequestRequeueRejectedTasksMode",
     "ReviewSettingsRequestReviewCriteria",
+    "ReviewSettingsRequestSampling",
     "ReviewSettingsRequeueRejectedTasksMode",
     "ReviewSettingsReviewCriteria",
+    "ReviewSettingsSampling",
+    "ReviewSettingsSamplingEnum",
     "ReviewedEnum",
     "Role9E7Enum",
     "RoleBasedTask",
@@ -569,7 +590,7 @@ __all__ = [
     "S3ImportStorage",
     "SamlSettings",
     "SamlSettingsUpdate",
-    "SamplingEnum",
+    "SamplingDe5Enum",
     "ScimSettings",
     "ScimSettingsUpdate",
     "ScopeEnum",
@@ -649,7 +670,6 @@ __all__ = [
     "annotation_reviews",
     "annotations",
     "billing",
-    "blueprints",
     "comments",
     "export_storage",
     "files",

{label_studio_sdk-2.0.8 → label_studio_sdk-2.0.9}/src/label_studio_sdk/base_client.py

@@ -11,7 +11,6 @@ from .annotation_history.client import AnnotationHistoryClient
 from .annotation_reviews.client import AnnotationReviewsClient
 from .annotations.client import AnnotationsClient
 from .billing.client import BillingClient
-from .blueprints.client import BlueprintsClient
 from .comments.client import CommentsClient
 from .users.client import UsersClient
 from .actions.client import ActionsClient
@@ -40,7 +39,6 @@ from .annotation_history.client import AsyncAnnotationHistoryClient
 from .annotation_reviews.client import AsyncAnnotationReviewsClient
 from .annotations.client import AsyncAnnotationsClient
 from .billing.client import AsyncBillingClient
-from .blueprints.client import AsyncBlueprintsClient
 from .comments.client import AsyncCommentsClient
 from .users.client import AsyncUsersClient
 from .actions.client import AsyncActionsClient
@@ -132,7 +130,6 @@ class LabelStudioBase:
         self.annotation_reviews = AnnotationReviewsClient(client_wrapper=self._client_wrapper)
         self.annotations = AnnotationsClient(client_wrapper=self._client_wrapper)
         self.billing = BillingClient(client_wrapper=self._client_wrapper)
-        self.blueprints = BlueprintsClient(client_wrapper=self._client_wrapper)
         self.comments = CommentsClient(client_wrapper=self._client_wrapper)
         self.users = UsersClient(client_wrapper=self._client_wrapper)
         self.actions = ActionsClient(client_wrapper=self._client_wrapper)
@@ -224,7 +221,6 @@ class AsyncLabelStudioBase:
         self.annotation_reviews = AsyncAnnotationReviewsClient(client_wrapper=self._client_wrapper)
         self.annotations = AsyncAnnotationsClient(client_wrapper=self._client_wrapper)
         self.billing = AsyncBillingClient(client_wrapper=self._client_wrapper)
-        self.blueprints = AsyncBlueprintsClient(client_wrapper=self._client_wrapper)
         self.comments = AsyncCommentsClient(client_wrapper=self._client_wrapper)
         self.users = AsyncUsersClient(client_wrapper=self._client_wrapper)
         self.actions = AsyncActionsClient(client_wrapper=self._client_wrapper)

{label_studio_sdk-2.0.8 → label_studio_sdk-2.0.9}/src/label_studio_sdk/core/client_wrapper.py

@@ -4,7 +4,7 @@ import httpx
 
 from .http_client import AsyncHttpClient, HttpClient
 
-VERSION = "2.0.8"
+VERSION = "2.0.9"
 
 class BaseClientWrapper:
     def __init__(

label_studio_sdk-2.0.9/src/label_studio_sdk/export_storage/__init__.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import ExportStorageListTypesResponseItem
+from . import azure, azure_spi, databricks, gcs, gcswif, local, redis, s3, s3s
+
+__all__ = [
+    "ExportStorageListTypesResponseItem",
+    "azure",
+    "azure_spi",
+    "databricks",
+    "gcs",
+    "gcswif",
+    "local",
+    "redis",
+    "s3",
+    "s3s",
+]

{label_studio_sdk-2.0.8 → label_studio_sdk-2.0.9}/src/label_studio_sdk/export_storage/client.py

@@ -3,6 +3,7 @@
 from ..core.client_wrapper import SyncClientWrapper
 from .azure.client import AzureClient
 from .azure_spi.client import AzureSpiClient
+from .databricks.client import DatabricksClient
 from .gcs.client import GcsClient
 from .gcswif.client import GcswifClient
 from .local.client import LocalClient
@@ -18,6 +19,7 @@ from ..core.api_error import ApiError
 from ..core.client_wrapper import AsyncClientWrapper
 from .azure.client import AsyncAzureClient
 from .azure_spi.client import AsyncAzureSpiClient
+from .databricks.client import AsyncDatabricksClient
 from .gcs.client import AsyncGcsClient
 from .gcswif.client import AsyncGcswifClient
 from .local.client import AsyncLocalClient
@@ -31,6 +33,7 @@ class ExportStorageClient:
         self._client_wrapper = client_wrapper
         self.azure = AzureClient(client_wrapper=self._client_wrapper)
         self.azure_spi = AzureSpiClient(client_wrapper=self._client_wrapper)
+        self.databricks = DatabricksClient(client_wrapper=self._client_wrapper)
         self.gcs = GcsClient(client_wrapper=self._client_wrapper)
         self.gcswif = GcswifClient(client_wrapper=self._client_wrapper)
         self.local = LocalClient(client_wrapper=self._client_wrapper)
@@ -88,6 +91,7 @@ class AsyncExportStorageClient:
         self._client_wrapper = client_wrapper
         self.azure = AsyncAzureClient(client_wrapper=self._client_wrapper)
         self.azure_spi = AsyncAzureSpiClient(client_wrapper=self._client_wrapper)
+        self.databricks = AsyncDatabricksClient(client_wrapper=self._client_wrapper)
         self.gcs = AsyncGcsClient(client_wrapper=self._client_wrapper)
         self.gcswif = AsyncGcswifClient(client_wrapper=self._client_wrapper)
         self.local = AsyncLocalClient(client_wrapper=self._client_wrapper)