cirro-api-client 1.0.3__tar.gz → 1.2.0__tar.gz

{cirro_api_client-1.0.3 → cirro_api_client-1.2.0}/PKG-INFO

@@ -1,20 +1,20 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: cirro_api_client
-Version: 1.0.3
+Version: 1.2.0
 Summary: A client library for accessing Cirro
 License: MIT
 Keywords: Cirro
 Author: Cirro
 Author-email: support@cirro.bio
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: License :: OSI Approved :: MIT License
 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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: attrs (>=21.3.0)
 Requires-Dist: httpx (>=0.20.0,<0.27.0)
 Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
@@ -30,7 +30,7 @@ This Python package is automatically generated by the [OpenAPI Python Client](ht
 
 ## Requirements.
 
-Python 3.8+.
+Python 3.9+.
 
 ## Installation & Usage
 ### pip install

{cirro_api_client-1.0.3 → cirro_api_client-1.2.0}/README.md

@@ -7,7 +7,7 @@ This Python package is automatically generated by the [OpenAPI Python Client](ht
 
 ## Requirements.
 
-Python 3.8+.
+Python 3.9+.
 
 ## Installation & Usage
 ### pip install

cirro_api_client-1.2.0/cirro_api_client/v1/api/datasets/get_sample_sheets.py

@@ -0,0 +1,176 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.sample_sheets import SampleSheets
+from ...types import Response
+
+
+def _get_kwargs(
+    project_id: str,
+    dataset_id: str,
+) -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": f"/projects/{project_id}/datasets/{dataset_id}/samplesheet",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[SampleSheets]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = SampleSheets.from_dict(response.json())
+
+        return response_200
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[SampleSheets]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    dataset_id: str,
+    *,
+    client: Client,
+) -> Response[SampleSheets]:
+    """Generate sample sheets
+
+     Generates the sample sheet output for this dataset, useful for debugging the preprocess script.
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[SampleSheets]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        dataset_id=dataset_id,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    project_id: str,
+    dataset_id: str,
+    *,
+    client: Client,
+) -> Optional[SampleSheets]:
+    """Generate sample sheets
+
+     Generates the sample sheet output for this dataset, useful for debugging the preprocess script.
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        SampleSheets
+    """
+
+    try:
+        return sync_detailed(
+            project_id=project_id,
+            dataset_id=dataset_id,
+            client=client,
+        ).parsed
+    except errors.NotFoundException:
+        return None
+
+
+async def asyncio_detailed(
+    project_id: str,
+    dataset_id: str,
+    *,
+    client: Client,
+) -> Response[SampleSheets]:
+    """Generate sample sheets
+
+     Generates the sample sheet output for this dataset, useful for debugging the preprocess script.
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[SampleSheets]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        dataset_id=dataset_id,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    project_id: str,
+    dataset_id: str,
+    *,
+    client: Client,
+) -> Optional[SampleSheets]:
+    """Generate sample sheets
+
+     Generates the sample sheet output for this dataset, useful for debugging the preprocess script.
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        SampleSheets
+    """
+
+    try:
+        return (
+            await asyncio_detailed(
+                project_id=project_id,
+                dataset_id=dataset_id,
+                client=client,
+            )
+        ).parsed
+    except errors.NotFoundException:
+        return None

cirro_api_client-1.2.0/cirro_api_client/v1/api/execution/calculate_cost.py

@@ -0,0 +1,176 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.cost_response import CostResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    project_id: str,
+    dataset_id: str,
+) -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": f"/projects/{project_id}/execution/{dataset_id}/cost",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[CostResponse]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = CostResponse.from_dict(response.json())
+
+        return response_200
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[CostResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    dataset_id: str,
+    *,
+    client: Client,
+) -> Response[CostResponse]:
+    """Calculate cost
+
+     Calculate cost of an execution run
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[CostResponse]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        dataset_id=dataset_id,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    project_id: str,
+    dataset_id: str,
+    *,
+    client: Client,
+) -> Optional[CostResponse]:
+    """Calculate cost
+
+     Calculate cost of an execution run
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        CostResponse
+    """
+
+    try:
+        return sync_detailed(
+            project_id=project_id,
+            dataset_id=dataset_id,
+            client=client,
+        ).parsed
+    except errors.NotFoundException:
+        return None
+
+
+async def asyncio_detailed(
+    project_id: str,
+    dataset_id: str,
+    *,
+    client: Client,
+) -> Response[CostResponse]:
+    """Calculate cost
+
+     Calculate cost of an execution run
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[CostResponse]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        dataset_id=dataset_id,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    project_id: str,
+    dataset_id: str,
+    *,
+    client: Client,
+) -> Optional[CostResponse]:
+    """Calculate cost
+
+     Calculate cost of an execution run
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        CostResponse
+    """
+
+    try:
+        return (
+            await asyncio_detailed(
+                project_id=project_id,
+                dataset_id=dataset_id,
+                client=client,
+            )
+        ).parsed
+    except errors.NotFoundException:
+        return None

cirro_api_client-1.2.0/cirro_api_client/v1/api/feed/create_discussion.py

@@ -0,0 +1,173 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.discussion import Discussion
+from ...models.discussion_input import DiscussionInput
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: DiscussionInput,
+) -> Dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "post",
+        "url": "/discussions",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Discussion]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = Discussion.from_dict(response.json())
+
+        return response_200
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[Discussion]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+    body: DiscussionInput,
+) -> Response[Discussion]:
+    """Create a discussion
+
+     Creates a new discussion for an entity
+
+    Args:
+        body (DiscussionInput):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Discussion]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Client,
+    body: DiscussionInput,
+) -> Optional[Discussion]:
+    """Create a discussion
+
+     Creates a new discussion for an entity
+
+    Args:
+        body (DiscussionInput):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Discussion
+    """
+
+    try:
+        return sync_detailed(
+            client=client,
+            body=body,
+        ).parsed
+    except errors.NotFoundException:
+        return None
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+    body: DiscussionInput,
+) -> Response[Discussion]:
+    """Create a discussion
+
+     Creates a new discussion for an entity
+
+    Args:
+        body (DiscussionInput):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Discussion]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Client,
+    body: DiscussionInput,
+) -> Optional[Discussion]:
+    """Create a discussion
+
+     Creates a new discussion for an entity
+
+    Args:
+        body (DiscussionInput):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Discussion
+    """
+
+    try:
+        return (
+            await asyncio_detailed(
+                client=client,
+                body=body,
+            )
+        ).parsed
+    except errors.NotFoundException:
+        return None

cirro_api_client-1.2.0/cirro_api_client/v1/api/feed/delete_discussion.py

@@ -0,0 +1,98 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...types import Response
+
+
+def _get_kwargs(
+    discussion_id: str,
+) -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "delete",
+        "url": f"/discussions/{discussion_id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
+    if response.status_code == HTTPStatus.OK:
+        return None
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    discussion_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Delete a discussion
+
+     Deletes an existing discussion and all associated messages
+
+    Args:
+        discussion_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        discussion_id=discussion_id,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    discussion_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Delete a discussion
+
+     Deletes an existing discussion and all associated messages
+
+    Args:
+        discussion_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        discussion_id=discussion_id,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)