label-studio-sdk 0.0.32__py3-none-any.whl → 1.0.0__py3-none-any.whl

label_studio_sdk/users/types/__init__.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .users_get_token_response import UsersGetTokenResponse
+from .users_reset_token_response import UsersResetTokenResponse
+
+__all__ = ["UsersGetTokenResponse", "UsersResetTokenResponse"]

label_studio_sdk/users/types/users_get_token_response.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...core.datetime_utils import serialize_datetime
+from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class UsersGetTokenResponse(pydantic_v1.BaseModel):
+    """
+    User token
+    """
+
+    detail: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Token
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/users/types/users_reset_token_response.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...core.datetime_utils import serialize_datetime
+from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class UsersResetTokenResponse(pydantic_v1.BaseModel):
+    """
+    User token
+    """
+
+    token: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Token
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/version.py

@@ -0,0 +1,4 @@
+
+from importlib import metadata
+
+__version__ = metadata.version("label-studio-sdk")

label_studio_sdk/views/__init__.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    ViewsCreateRequestData,
+    ViewsCreateRequestDataFilters,
+    ViewsCreateRequestDataFiltersConjunction,
+    ViewsCreateRequestDataFiltersItemsItem,
+    ViewsCreateRequestDataOrderingItem,
+    ViewsCreateRequestDataOrderingItemDirection,
+    ViewsUpdateRequestData,
+    ViewsUpdateRequestDataFilters,
+    ViewsUpdateRequestDataFiltersConjunction,
+    ViewsUpdateRequestDataFiltersItemsItem,
+    ViewsUpdateRequestDataOrderingItem,
+    ViewsUpdateRequestDataOrderingItemDirection,
+)
+
+__all__ = [
+    "ViewsCreateRequestData",
+    "ViewsCreateRequestDataFilters",
+    "ViewsCreateRequestDataFiltersConjunction",
+    "ViewsCreateRequestDataFiltersItemsItem",
+    "ViewsCreateRequestDataOrderingItem",
+    "ViewsCreateRequestDataOrderingItemDirection",
+    "ViewsUpdateRequestData",
+    "ViewsUpdateRequestDataFilters",
+    "ViewsUpdateRequestDataFiltersConjunction",
+    "ViewsUpdateRequestDataFiltersItemsItem",
+    "ViewsUpdateRequestDataOrderingItem",
+    "ViewsUpdateRequestDataOrderingItemDirection",
+]

label_studio_sdk/views/client.py

@@ -0,0 +1,564 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pydantic_utilities import pydantic_v1
+from ..core.request_options import RequestOptions
+from ..types.view import View
+from .types.views_create_request_data import ViewsCreateRequestData
+from .types.views_update_request_data import ViewsUpdateRequestData
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class ViewsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[View]:
+        """
+        List all views for a specific project. A view is a tab in the Data Manager where you can set filters and customize which tasks and information appears.
+
+        You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
+
+        Parameters
+        ----------
+        project : typing.Optional[int]
+            Project ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[View]
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.views.list()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/dm/views/", method="GET", params={"project": project}, request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(typing.List[View], _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def create(
+        self,
+        *,
+        data: typing.Optional[ViewsCreateRequestData] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> View:
+        """
+        Create a new Data Manager view for a specific project. A view is a tab in the Data Manager where you can set filters and customize what tasks and information appears.
+
+        You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
+
+        Parameters
+        ----------
+        data : typing.Optional[ViewsCreateRequestData]
+            Custom view data
+
+        project : typing.Optional[int]
+            Project ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        View
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.views.create()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/dm/views/",
+            method="POST",
+            json={"data": data, "project": project},
+            request_options=request_options,
+            omit=OMIT,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def delete_all(self, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Delete all views for a specific project. A view is a tab in the Data Manager where you can set filters and customize what tasks appear.
+
+        You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
+
+        Parameters
+        ----------
+        project : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.views.delete_all(
+            project=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/dm/views/reset/",
+            method="DELETE",
+            json={"project": project},
+            request_options=request_options,
+            omit=OMIT,
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> View:
+        """
+        Get the details about a specific Data Manager view (tab). You will need to supply the view ID. You can find this using [List views](list).
+
+        Parameters
+        ----------
+        id : str
+            View ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        View
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.views.get(
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/dm/views/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Delete a specific Data Manager view (tab) by ID. You can find the view using [List views](list).
+
+        Parameters
+        ----------
+        id : str
+            View ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.views.delete(
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/dm/views/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def update(
+        self,
+        id: str,
+        *,
+        data: typing.Optional[ViewsUpdateRequestData] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> View:
+        """
+        You can update a specific Data Manager view (tab) with additional filters and other customizations. You will need to supply the view ID. You can find this using [List views](list).
+
+        Parameters
+        ----------
+        id : str
+            View ID
+
+        data : typing.Optional[ViewsUpdateRequestData]
+            Custom view data
+
+        project : typing.Optional[int]
+            Project ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        View
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.views.update(
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="PATCH",
+            json={"data": data, "project": project},
+            request_options=request_options,
+            omit=OMIT,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncViewsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[View]:
+        """
+        List all views for a specific project. A view is a tab in the Data Manager where you can set filters and customize which tasks and information appears.
+
+        You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
+
+        Parameters
+        ----------
+        project : typing.Optional[int]
+            Project ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[View]
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.views.list()
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/dm/views/", method="GET", params={"project": project}, request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(typing.List[View], _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def create(
+        self,
+        *,
+        data: typing.Optional[ViewsCreateRequestData] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> View:
+        """
+        Create a new Data Manager view for a specific project. A view is a tab in the Data Manager where you can set filters and customize what tasks and information appears.
+
+        You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
+
+        Parameters
+        ----------
+        data : typing.Optional[ViewsCreateRequestData]
+            Custom view data
+
+        project : typing.Optional[int]
+            Project ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        View
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.views.create()
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/dm/views/",
+            method="POST",
+            json={"data": data, "project": project},
+            request_options=request_options,
+            omit=OMIT,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def delete_all(self, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Delete all views for a specific project. A view is a tab in the Data Manager where you can set filters and customize what tasks appear.
+
+        You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
+
+        Parameters
+        ----------
+        project : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.views.delete_all(
+            project=1,
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/dm/views/reset/",
+            method="DELETE",
+            json={"project": project},
+            request_options=request_options,
+            omit=OMIT,
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> View:
+        """
+        Get the details about a specific Data Manager view (tab). You will need to supply the view ID. You can find this using [List views](list).
+
+        Parameters
+        ----------
+        id : str
+            View ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        View
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.views.get(
+            id="id",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/dm/views/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Delete a specific Data Manager view (tab) by ID. You can find the view using [List views](list).
+
+        Parameters
+        ----------
+        id : str
+            View ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.views.delete(
+            id="id",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/dm/views/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def update(
+        self,
+        id: str,
+        *,
+        data: typing.Optional[ViewsUpdateRequestData] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> View:
+        """
+        You can update a specific Data Manager view (tab) with additional filters and other customizations. You will need to supply the view ID. You can find this using [List views](list).
+
+        Parameters
+        ----------
+        id : str
+            View ID
+
+        data : typing.Optional[ViewsUpdateRequestData]
+            Custom view data
+
+        project : typing.Optional[int]
+            Project ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        View
+
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.views.update(
+            id="id",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="PATCH",
+            json={"data": data, "project": project},
+            request_options=request_options,
+            omit=OMIT,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)