# This file was auto-generated by Fern from our API Definition.
import typing
from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...types.project import Project
from .raw_client import AsyncRawProjectsClient, RawProjectsClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class ProjectsClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawProjectsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawProjectsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawProjectsClient
"""
return self._raw_client
def list(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Project]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a list of all projects in a specific workspace.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[Project]
Projects list
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.workspaces.projects.list(
id=1,
)
"""
_response = self._raw_client.list(id, request_options=request_options)
return _response.data
def add(self, id: int, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Add a project to a specific workspace.
Parameters
----------
id : int
project : int
Project ID
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.workspaces.projects.add(
id=1,
project=1,
)
"""
_response = self._raw_client.add(id, project=project, request_options=request_options)
return _response.data
def remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Remove a project from a specific workspace.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from label_studio_sdk import LabelStudio
client = LabelStudio(
api_key="YOUR_API_KEY",
)
client.workspaces.projects.remove(
id=1,
)
"""
_response = self._raw_client.remove(id, request_options=request_options)
return _response.data
class AsyncProjectsClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawProjectsClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawProjectsClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawProjectsClient
"""
return self._raw_client
async def list(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Project]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve a list of all projects in a specific workspace.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.List[Project]
Projects list
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspaces.projects.list(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.list(id, request_options=request_options)
return _response.data
async def add(self, id: int, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Add a project to a specific workspace.
Parameters
----------
id : int
project : int
Project ID
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspaces.projects.add(
id=1,
project=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.add(id, project=project, request_options=request_options)
return _response.data
async def remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Remove a project from a specific workspace.
Parameters
----------
id : int
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
import asyncio
from label_studio_sdk import AsyncLabelStudio
client = AsyncLabelStudio(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workspaces.projects.remove(
id=1,
)
asyncio.run(main())
"""
_response = await self._raw_client.remove(id, request_options=request_options)
return _response.data