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

label_studio_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,307 @@
+Metadata-Version: 2.1
+Name: label-studio-sdk
+Version: 1.0.0
+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 -->
+
+- [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/).
+
+
+<!-- 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(
+    api_key="YOUR_API_KEY",
+)
+```
+<!-- End Usage  -->
+
+# Examples
+
+## Get all projects
+
+```python
+projects = client.projects.list()
+```
+
+## Create a new project
+
+```python
+project = client.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>
+    """
+)
+```
+
+## 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"
+        }
+    }
+)
+```
+
+## Delete task
+
+```python
+client.tasks.delete(project="PROJECT_ID", task="TASK_ID")
+```
+
+## 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
+
+```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/README.md

@@ -0,0 +1,270 @@
+# 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 -->
+
+- [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/).
+
+
+<!-- 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(
+    api_key="YOUR_API_KEY",
+)
+```
+<!-- End Usage  -->
+
+# Examples
+
+## Get all projects
+
+```python
+projects = client.projects.list()
+```
+
+## Create a new project
+
+```python
+project = client.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>
+    """
+)
+```
+
+## 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"
+        }
+    }
+)
+```
+
+## Delete task
+
+```python
+client.tasks.delete(project="PROJECT_ID", task="TASK_ID")
+```
+
+## 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
+
+```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/pyproject.toml

@@ -0,0 +1,67 @@
+[tool.poetry]
+name = "label-studio-sdk"
+version = "1.0.0"
+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.9.0"
+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"