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

label_studio_sdk-1.0.1/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.1
+Name: label-studio-sdk
+Version: 1.0.1
+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)
+
+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.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.1/pyproject.toml

@@ -0,0 +1,67 @@
+[tool.poetry]
+name = "label-studio-sdk"
+version = "1.0.1"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "label_studio_sdk", from = "src"}
+]
+
+[project.urls]
+Repository = 'https://github.com/HumanSignal/label-studio-sdk'
+
+[tool.poetry.dependencies]
+python = "^3.8"
+Pillow = ">=10.0.1"
+appdirs = ">=1.4.3"
+httpx = ">=0.21.2"
+ijson = ">=3.2.3"
+jsonschema = "3.2.0"
+lxml = ">=4.2.5"
+nltk = "3.6.7"
+pandas = ">=0.24.0"
+pydantic = ">= 1.9.2"
+requests = ">=2.22.0"
+requests-mock = "1.12.1"
+typing_extensions = ">= 4.0.0"
+ujson = ">=5.8.0"
+xmljson = "0.2.1"
+
+[tool.poetry.dev-dependencies]
+mypy = "1.0.1"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

label_studio_sdk-1.0.1/src/label_studio_sdk/__init__.py

@@ -0,0 +1,234 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    Annotation,
+    AnnotationFilterOptions,
+    AnnotationLastAction,
+    AzureBlobExportStorage,
+    AzureBlobExportStorageStatus,
+    AzureBlobImportStorage,
+    AzureBlobImportStorageStatus,
+    BaseTask,
+    BaseUser,
+    ConvertedFormat,
+    ConvertedFormatStatus,
+    Export,
+    ExportConvert,
+    ExportCreate,
+    ExportCreateStatus,
+    ExportStatus,
+    FileUpload,
+    Filter,
+    FilterGroup,
+    GcsExportStorage,
+    GcsExportStorageStatus,
+    GcsImportStorage,
+    GcsImportStorageStatus,
+    LocalFilesExportStorage,
+    LocalFilesExportStorageStatus,
+    LocalFilesImportStorage,
+    LocalFilesImportStorageStatus,
+    MlBackend,
+    MlBackendAuthMethod,
+    MlBackendState,
+    Prediction,
+    Project,
+    ProjectImport,
+    ProjectImportStatus,
+    ProjectLabelConfig,
+    ProjectSampling,
+    ProjectSkipQueue,
+    RedisExportStorage,
+    RedisExportStorageStatus,
+    RedisImportStorage,
+    RedisImportStorageStatus,
+    S3ExportStorage,
+    S3ExportStorageStatus,
+    S3ImportStorage,
+    S3ImportStorageStatus,
+    SerializationOption,
+    SerializationOptions,
+    Task,
+    TaskFilterOptions,
+    UserSimple,
+    View,
+    Webhook,
+    WebhookActionsItem,
+    WebhookSerializerForUpdate,
+    WebhookSerializerForUpdateActionsItem,
+)
+from .errors import BadRequestError, InternalServerError
+from . import (
+    actions,
+    annotations,
+    export_storage,
+    files,
+    import_storage,
+    ml,
+    predictions,
+    projects,
+    tasks,
+    users,
+    views,
+    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
+from .ml import (
+    MlCreateRequestAuthMethod,
+    MlCreateResponse,
+    MlCreateResponseAuthMethod,
+    MlUpdateRequestAuthMethod,
+    MlUpdateResponse,
+    MlUpdateResponseAuthMethod,
+)
+from .projects import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse
+from .tasks import TasksListRequestFields, TasksListResponse
+from .users import UsersGetTokenResponse, UsersResetTokenResponse
+from .version import __version__
+from .views import (
+    ViewsCreateRequestData,
+    ViewsCreateRequestDataFilters,
+    ViewsCreateRequestDataFiltersConjunction,
+    ViewsCreateRequestDataFiltersItemsItem,
+    ViewsCreateRequestDataFiltersItemsItemFilter,
+    ViewsCreateRequestDataFiltersItemsItemOperator,
+    ViewsCreateRequestDataOrderingItem,
+    ViewsUpdateRequestData,
+    ViewsUpdateRequestDataFilters,
+    ViewsUpdateRequestDataFiltersConjunction,
+    ViewsUpdateRequestDataFiltersItemsItem,
+    ViewsUpdateRequestDataFiltersItemsItemFilter,
+    ViewsUpdateRequestDataFiltersItemsItemOperator,
+    ViewsUpdateRequestDataOrderingItem,
+)
+from .webhooks import WebhooksUpdateRequestActionsItem
+
+__all__ = [
+    "ActionsCreateRequestFilters",
+    "ActionsCreateRequestFiltersConjunction",
+    "ActionsCreateRequestFiltersItemsItem",
+    "ActionsCreateRequestFiltersItemsItemFilter",
+    "ActionsCreateRequestFiltersItemsItemOperator",
+    "ActionsCreateRequestId",
+    "ActionsCreateRequestOrderingItem",
+    "ActionsCreateRequestSelectedItems",
+    "ActionsCreateRequestSelectedItemsExcluded",
+    "ActionsCreateRequestSelectedItemsIncluded",
+    "Annotation",
+    "AnnotationFilterOptions",
+    "AnnotationLastAction",
+    "AzureBlobExportStorage",
+    "AzureBlobExportStorageStatus",
+    "AzureBlobImportStorage",
+    "AzureBlobImportStorageStatus",
+    "BadRequestError",
+    "BaseTask",
+    "BaseUser",
+    "Client",
+    "ConvertedFormat",
+    "ConvertedFormatStatus",
+    "Export",
+    "ExportConvert",
+    "ExportCreate",
+    "ExportCreateStatus",
+    "ExportStatus",
+    "ExportStorageListTypesResponseItem",
+    "FileUpload",
+    "Filter",
+    "FilterGroup",
+    "GcsExportStorage",
+    "GcsExportStorageStatus",
+    "GcsImportStorage",
+    "GcsImportStorageStatus",
+    "ImportStorageListTypesResponseItem",
+    "InternalServerError",
+    "LabelStudioEnvironment",
+    "LocalFilesExportStorage",
+    "LocalFilesExportStorageStatus",
+    "LocalFilesImportStorage",
+    "LocalFilesImportStorageStatus",
+    "MlBackend",
+    "MlBackendAuthMethod",
+    "MlBackendState",
+    "MlCreateRequestAuthMethod",
+    "MlCreateResponse",
+    "MlCreateResponseAuthMethod",
+    "MlUpdateRequestAuthMethod",
+    "MlUpdateResponse",
+    "MlUpdateResponseAuthMethod",
+    "Prediction",
+    "Project",
+    "ProjectImport",
+    "ProjectImportStatus",
+    "ProjectLabelConfig",
+    "ProjectSampling",
+    "ProjectSkipQueue",
+    "ProjectsCreateResponse",
+    "ProjectsImportTasksResponse",
+    "ProjectsListResponse",
+    "RedisExportStorage",
+    "RedisExportStorageStatus",
+    "RedisImportStorage",
+    "RedisImportStorageStatus",
+    "S3ExportStorage",
+    "S3ExportStorageStatus",
+    "S3ImportStorage",
+    "S3ImportStorageStatus",
+    "SerializationOption",
+    "SerializationOptions",
+    "Task",
+    "TaskFilterOptions",
+    "TasksListRequestFields",
+    "TasksListResponse",
+    "UserSimple",
+    "UsersGetTokenResponse",
+    "UsersResetTokenResponse",
+    "View",
+    "ViewsCreateRequestData",
+    "ViewsCreateRequestDataFilters",
+    "ViewsCreateRequestDataFiltersConjunction",
+    "ViewsCreateRequestDataFiltersItemsItem",
+    "ViewsCreateRequestDataFiltersItemsItemFilter",
+    "ViewsCreateRequestDataFiltersItemsItemOperator",
+    "ViewsCreateRequestDataOrderingItem",
+    "ViewsUpdateRequestData",
+    "ViewsUpdateRequestDataFilters",
+    "ViewsUpdateRequestDataFiltersConjunction",
+    "ViewsUpdateRequestDataFiltersItemsItem",
+    "ViewsUpdateRequestDataFiltersItemsItemFilter",
+    "ViewsUpdateRequestDataFiltersItemsItemOperator",
+    "ViewsUpdateRequestDataOrderingItem",
+    "Webhook",
+    "WebhookActionsItem",
+    "WebhookSerializerForUpdate",
+    "WebhookSerializerForUpdateActionsItem",
+    "WebhooksUpdateRequestActionsItem",
+    "__version__",
+    "actions",
+    "annotations",
+    "export_storage",
+    "files",
+    "import_storage",
+    "ml",
+    "predictions",
+    "projects",
+    "tasks",
+    "users",
+    "views",
+    "webhooks",
+]