octostar-python-client 0.1.759__py3-none-any.whl

octostar/__init__.py

@@ -0,0 +1,9 @@
+"""A client library for accessing Octostar API"""
+
+from .client import AuthenticatedClient, Client, make_client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+    "make_client",
+)

octostar/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

octostar/api/apps/deploy_app.py

@@ -0,0 +1,210 @@
+"""Deploy an app via the FastAPI backend."""
+
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+from warnings import warn
+
+import httpx
+
+from ...client import Client, get_default_client
+from ...types import Response, UNSET, Unset
+from ... import errors
+from ...models.deploy_app_json_body import DeployAppJsonBody
+
+
+client_missing_msg = """No client was passed to this function. The default admin client will be used, but this is deprecated and will be removed soon.
+Please create a client using octostar.client.make_client() and run the function via client.execute()."""
+
+
+def _get_kwargs(
+    workspace: str,
+    os_entity_uid: str,
+    *,
+    client: Client = None,
+    json_body: DeployAppJsonBody = None,
+) -> Dict[str, Any]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    base_url = client.get_base_url_v1()
+    url = f"{base_url}/api/v1/apps/deploy/{workspace}/{os_entity_uid}"
+
+    headers: Dict[str, str] = client.get_headers()
+    headers["Content-Type"] = "application/json"
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    # Convert the old DeployAppJsonBody to the new format
+    json_data = None
+    if json_body:
+        body_dict = json_body.to_dict()
+        if body_dict.get("secrets"):
+            json_data = {"secrets": body_dict["secrets"]}
+
+    return {
+        "method": "post",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
+        "json": json_data,
+    }
+
+
+def _parse_response(
+    *, client: Client = None, response: httpx.Response
+) -> Optional[Dict[str, Any]]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    if response.status_code == HTTPStatus.OK:
+        return response.json()
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    return None
+
+
+def _build_response(
+    *, client: Client = None, response: httpx.Response
+) -> Response[Dict[str, Any]]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    workspace: str,
+    os_entity_uid: str,
+    *,
+    client: Client = None,
+    json_body: DeployAppJsonBody = None,
+) -> Response[Dict[str, Any]]:
+    """Deploy an app from a manifest.
+
+    Args:
+        workspace: The workspace ID containing the app folder.
+        os_entity_uid: The entity ID of the app folder.
+        client: The Client with which to connect to Octostar.
+        json_body: Optional DeployAppJsonBody with secrets.
+
+    Returns:
+        Response with deployment data including:
+        - status: "success" or "error"
+        - data: Updated app entity data
+    """
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        os_entity_uid=os_entity_uid,
+        client=client,
+        json_body=json_body,
+    )
+
+    response = httpx.request(verify=client.verify_ssl, **kwargs)
+    if response.is_error:
+        print(
+            f"{response.status_code} Error: {response.text} for request",
+            str(kwargs),
+        )
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    workspace: str,
+    os_entity_uid: str,
+    *,
+    client: Client = None,
+    json_body: DeployAppJsonBody = None,
+) -> Optional[Dict[str, Any]]:
+    """Deploy an app from a manifest.
+
+    Args:
+        workspace: The workspace ID containing the app folder.
+        os_entity_uid: The entity ID of the app folder.
+        client: The Client with which to connect to Octostar.
+        json_body: Optional DeployAppJsonBody with secrets.
+
+    Returns:
+        Deployment data or None if request failed.
+    """
+    return sync_detailed(
+        workspace=workspace,
+        os_entity_uid=os_entity_uid,
+        client=client,
+        json_body=json_body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    workspace: str,
+    os_entity_uid: str,
+    *,
+    client: Client = None,
+    json_body: DeployAppJsonBody = None,
+) -> Response[Dict[str, Any]]:
+    """Deploy an app from a manifest asynchronously.
+
+    Args:
+        workspace: The workspace ID containing the app folder.
+        os_entity_uid: The entity ID of the app folder.
+        client: The Client with which to connect to Octostar.
+        json_body: Optional DeployAppJsonBody with secrets.
+
+    Returns:
+        Response with deployment data.
+    """
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        os_entity_uid=os_entity_uid,
+        client=client,
+        json_body=json_body,
+    )
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    workspace: str,
+    os_entity_uid: str,
+    *,
+    client: Client = None,
+    json_body: DeployAppJsonBody = None,
+) -> Optional[Dict[str, Any]]:
+    """Deploy an app from a manifest asynchronously.
+
+    Args:
+        workspace: The workspace ID containing the app folder.
+        os_entity_uid: The entity ID of the app folder.
+        client: The Client with which to connect to Octostar.
+        json_body: Optional DeployAppJsonBody with secrets.
+
+    Returns:
+        Deployment data or None if request failed.
+    """
+    return (
+        await asyncio_detailed(
+            workspace=workspace,
+            os_entity_uid=os_entity_uid,
+            client=client,
+            json_body=json_body,
+        )
+    ).parsed

octostar/api/apps/execute_app_job.py

@@ -0,0 +1,188 @@
+"""Execute a job via the FastAPI backend."""
+
+from http import HTTPStatus
+from typing import Any, Dict, List, Optional, Union
+from warnings import warn
+
+import httpx
+
+from ...client import Client, get_default_client
+from ...types import Response, UNSET, Unset
+from ... import errors
+from ...models.execute_app_job_json_body import ExecuteAppJobJsonBody
+
+
+client_missing_msg = """No client was passed to this function. The default admin client will be used, but this is deprecated and will be removed soon.
+Please create a client using octostar.client.make_client() and run the function via client.execute()."""
+
+
+def _get_kwargs(
+    *,
+    client: Client = None,
+    json_body: ExecuteAppJobJsonBody = None,
+) -> Dict[str, Any]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    base_url = client.get_base_url_v1()
+    url = f"{base_url}/api/v1/apps/jobs/execute"
+
+    headers: Dict[str, str] = client.get_headers()
+    headers["Content-Type"] = "application/json"
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    if not json_body:
+        raise ValueError("json_body is required for executing a job")
+
+    # Convert old ExecuteAppJobJsonBody to new JobExecuteRequest format
+    body_dict = json_body.to_dict()
+
+    # Map old format to new format
+    # Old: ancestor, ontology, image, is_frontend, archive, manifest, annotation, commands
+    # New: ancestor, commands, environment, annotations, timeout
+
+    commands = body_dict.get("commands", [])
+    if isinstance(commands, str):
+        commands = [commands]
+
+    json_data = {
+        "ancestor": body_dict["ancestor"],
+        "commands": commands,
+    }
+
+    # Map annotation to annotations
+    if "annotation" in body_dict and body_dict["annotation"]:
+        json_data["annotations"] = body_dict["annotation"]
+
+    return {
+        "method": "post",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
+        "json": json_data,
+    }
+
+
+def _parse_response(
+    *, client: Client = None, response: httpx.Response
+) -> Optional[Dict[str, Any]]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    if response.status_code == HTTPStatus.OK:
+        return response.json()
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    return None
+
+
+def _build_response(
+    *, client: Client = None, response: httpx.Response
+) -> Response[Dict[str, Any]]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    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 = None,
+    json_body: ExecuteAppJobJsonBody = None,
+) -> Response[Dict[str, Any]]:
+    """Execute a new job.
+
+    Args:
+        client: The Client with which to connect to Octostar.
+        json_body: ExecuteAppJobJsonBody with job configuration.
+
+    Returns:
+        Response with job execution data including:
+        - job_id: The generated job ID
+        - status: Job status
+        - ancestor: Parent app ID
+        - namespace: K8s namespace
+    """
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    kwargs = _get_kwargs(client=client, json_body=json_body)
+
+    response = httpx.request(verify=client.verify_ssl, **kwargs)
+    if response.is_error:
+        print(
+            f"{response.status_code} Error: {response.text} for request",
+            str(kwargs),
+        )
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Client = None,
+    json_body: ExecuteAppJobJsonBody = None,
+) -> Optional[Dict[str, Any]]:
+    """Execute a new job.
+
+    Args:
+        client: The Client with which to connect to Octostar.
+        json_body: ExecuteAppJobJsonBody with job configuration.
+
+    Returns:
+        Job execution data or None if request failed.
+    """
+    return sync_detailed(client=client, json_body=json_body).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Client = None,
+    json_body: ExecuteAppJobJsonBody = None,
+) -> Response[Dict[str, Any]]:
+    """Execute a new job asynchronously.
+
+    Args:
+        client: The Client with which to connect to Octostar.
+        json_body: ExecuteAppJobJsonBody with job configuration.
+
+    Returns:
+        Response with job execution data.
+    """
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    kwargs = _get_kwargs(client=client, json_body=json_body)
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Client = None,
+    json_body: ExecuteAppJobJsonBody = None,
+) -> Optional[Dict[str, Any]]:
+    """Execute a new job asynchronously.
+
+    Args:
+        client: The Client with which to connect to Octostar.
+        json_body: ExecuteAppJobJsonBody with job configuration.
+
+    Returns:
+        Job execution data or None if request failed.
+    """
+    return (await asyncio_detailed(client=client, json_body=json_body)).parsed

octostar/api/apps/get_app_logs.py

@@ -0,0 +1,210 @@
+"""Get app logs from the FastAPI backend."""
+
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+from warnings import warn
+
+import httpx
+
+from ...client import Client, get_default_client
+from ...types import Response, UNSET, Unset
+from ... import errors
+
+
+client_missing_msg = """No client was passed to this function. The default admin client will be used, but this is deprecated and will be removed soon.
+Please create a client using octostar.client.make_client() and run the function via client.execute()."""
+
+
+def _get_kwargs(
+    app_id: str,
+    *,
+    client: Client = None,
+    since_seconds: Union[Unset, None, int] = UNSET,
+    tail_lines: Union[Unset, None, int] = UNSET,
+) -> Dict[str, Any]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    base_url = client.get_base_url_v1()
+    url = f"{base_url}/api/v1/apps/logs/{app_id}"
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    params: Dict[str, Any] = {}
+    if not isinstance(since_seconds, Unset) and since_seconds is not None:
+        params["since_seconds"] = since_seconds
+    if not isinstance(tail_lines, Unset) and tail_lines is not None:
+        params["tail_lines"] = tail_lines
+
+    return {
+        "method": "get",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "params": params,
+        "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
+    }
+
+
+def _parse_response(
+    *, client: Client = None, response: httpx.Response
+) -> Optional[bytes]:
+    """Parse response - returns raw bytes for log content."""
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    if response.status_code == HTTPStatus.OK:
+        return response.content
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    return None
+
+
+def _build_response(
+    *, client: Client = None, response: httpx.Response
+) -> Response[bytes]:
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    app_id: str,
+    *,
+    client: Client = None,
+    since_seconds: Union[Unset, None, int] = UNSET,
+    tail_lines: Union[Unset, None, int] = UNSET,
+) -> Response[bytes]:
+    """Get app logs.
+
+    Args:
+        app_id: The app ID or alias to get logs for.
+        client: The Client with which to connect to Octostar.
+        since_seconds: Only return logs from the last N seconds.
+        tail_lines: Only return the last N lines.
+
+    Returns:
+        Response with raw log content in bytes.
+    """
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    kwargs = _get_kwargs(
+        app_id=app_id,
+        client=client,
+        since_seconds=since_seconds,
+        tail_lines=tail_lines,
+    )
+
+    response = httpx.request(verify=client.verify_ssl, **kwargs)
+    if response.is_error:
+        print(
+            f"{response.status_code} Error: {response.text} for request",
+            str(kwargs),
+        )
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    app_id: str,
+    *,
+    client: Client = None,
+    since_seconds: Union[Unset, None, int] = UNSET,
+    tail_lines: Union[Unset, None, int] = UNSET,
+) -> Optional[bytes]:
+    """Get app logs.
+
+    Args:
+        app_id: The app ID or alias to get logs for.
+        client: The Client with which to connect to Octostar.
+        since_seconds: Only return logs from the last N seconds.
+        tail_lines: Only return the last N lines.
+
+    Returns:
+        Raw log content or None if request failed.
+    """
+    response = sync_detailed(
+        app_id=app_id,
+        client=client,
+        since_seconds=since_seconds,
+        tail_lines=tail_lines,
+    )
+    if response.status_code == HTTPStatus.OK:
+        return response.content
+    return None
+
+
+async def asyncio_detailed(
+    app_id: str,
+    *,
+    client: Client = None,
+    since_seconds: Union[Unset, None, int] = UNSET,
+    tail_lines: Union[Unset, None, int] = UNSET,
+) -> Response[bytes]:
+    """Get app logs asynchronously.
+
+    Args:
+        app_id: The app ID or alias to get logs for.
+        client: The Client with which to connect to Octostar.
+        since_seconds: Only return logs from the last N seconds.
+        tail_lines: Only return the last N lines.
+
+    Returns:
+        Response with raw log content.
+    """
+    if not client:
+        warn(client_missing_msg, FutureWarning, stacklevel=2)
+        client = get_default_client()
+
+    kwargs = _get_kwargs(
+        app_id=app_id,
+        client=client,
+        since_seconds=since_seconds,
+        tail_lines=tail_lines,
+    )
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    app_id: str,
+    *,
+    client: Client = None,
+    since_seconds: Union[Unset, None, int] = UNSET,
+    tail_lines: Union[Unset, None, int] = UNSET,
+) -> Optional[bytes]:
+    """Get app logs asynchronously.
+
+    Args:
+        app_id: The app ID or alias to get logs for.
+        client: The Client with which to connect to Octostar.
+        since_seconds: Only return logs from the last N seconds.
+        tail_lines: Only return the last N lines.
+
+    Returns:
+        Raw log content or None if request failed.
+    """
+    response = await asyncio_detailed(
+        app_id=app_id,
+        client=client,
+        since_seconds=since_seconds,
+        tail_lines=tail_lines,
+    )
+    if response.status_code == HTTPStatus.OK:
+        return response.content
+    return None