octostar-python-client 1.0.0__tar.gz

octostar-python-client-1.0.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.1
+Name: octostar-python-client
+Version: 1.0.0
+Summary: A client library for accessing Octostar API
+Requires-Python: >=3.8, <4
+Description-Content-Type: text/markdown
+
+# octostar-python-client
+A client library for accessing Octostar API
+
+## Usage
+First, create a client:
+
+```python
+from octostar import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from octostar import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from octostar.models import MyDataModel
+from octostar.api.my_tag import get_my_data_model
+from octostar.types import Response
+
+my_data: MyDataModel = get_my_data_model.sync(client=client)
+# or if you need more info (e.g. status_code)
+response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from octostar.models import MyDataModel
+from octostar.api.my_tag import get_my_data_model
+from octostar.types import Response
+
+my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken", 
+    verify_ssl=False
+)
+```
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info.
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `octostar.api.default`
+
+## Building / publishing this Client
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
+1. Update the metadata in pyproject.toml (e.g. authors, version)
+1. If you're using a private repository, configure it with Poetry
+    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
+    1. `poetry config http-basic.<your-repository-name> <username> <password>`
+1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
+1. If that project is not using Poetry:
+    1. Build a wheel with `poetry build -f wheel`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`

octostar-python-client-1.0.0/README.md

@@ -0,0 +1,89 @@
+# octostar-python-client
+A client library for accessing Octostar API
+
+## Usage
+First, create a client:
+
+```python
+from octostar import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from octostar import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from octostar.models import MyDataModel
+from octostar.api.my_tag import get_my_data_model
+from octostar.types import Response
+
+my_data: MyDataModel = get_my_data_model.sync(client=client)
+# or if you need more info (e.g. status_code)
+response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from octostar.models import MyDataModel
+from octostar.api.my_tag import get_my_data_model
+from octostar.types import Response
+
+my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com", 
+    token="SuperSecretToken", 
+    verify_ssl=False
+)
+```
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info.
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `octostar.api.default`
+
+## Building / publishing this Client
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
+1. Update the metadata in pyproject.toml (e.g. authors, version)
+1. If you're using a private repository, configure it with Poetry
+    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
+    1. `poetry config http-basic.<your-repository-name> <username> <password>`
+1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
+1. If that project is not using Poetry:
+    1. Build a wheel with `poetry build -f wheel`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`

octostar-python-client-1.0.0/octostar/__init__.py

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

octostar-python-client-1.0.0/octostar/api/__init__.py

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

octostar-python-client-1.0.0/octostar/api/default/post_api_octostar_workspace_data_api_zip_import.py

@@ -0,0 +1,265 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import Client, get_default_client
+from ...models.post_api_octostar_workspace_data_api_zip_import_multipart_data import (
+    PostApiOctostarWorkspaceDataApiZipImportMultipartData,
+)
+from ...models.post_api_octostar_workspace_data_api_zip_import_response_200 import (
+    PostApiOctostarWorkspaceDataApiZipImportResponse200,
+)
+from ...models.post_api_octostar_workspace_data_api_zip_import_response_400 import (
+    PostApiOctostarWorkspaceDataApiZipImportResponse400,
+)
+from ...models.post_api_octostar_workspace_data_api_zip_import_response_403 import (
+    PostApiOctostarWorkspaceDataApiZipImportResponse403,
+)
+from ...models.post_api_octostar_workspace_data_api_zip_import_response_500 import (
+    PostApiOctostarWorkspaceDataApiZipImportResponse500,
+)
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    client: Client = None,
+    multipart_data: PostApiOctostarWorkspaceDataApiZipImportMultipartData,
+) -> Dict[str, Any]:
+    if not client:
+        client = get_default_client()
+    url = "{}/api/octostar/workspace_data_api/zip_import".format(client.base_url)
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    multipart_multipart_data = multipart_data.to_multipart()
+
+    return {
+        "method": "post",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
+        "files": multipart_multipart_data,
+    }
+
+
+def _parse_response(
+    *, client: Client = None, response: httpx.Response
+) -> Optional[
+    Union[
+        PostApiOctostarWorkspaceDataApiZipImportResponse200,
+        PostApiOctostarWorkspaceDataApiZipImportResponse400,
+        PostApiOctostarWorkspaceDataApiZipImportResponse403,
+        PostApiOctostarWorkspaceDataApiZipImportResponse500,
+    ]
+]:
+    if not client:
+        client = get_default_client()
+    if response.status_code == HTTPStatus.OK:
+        response_200 = PostApiOctostarWorkspaceDataApiZipImportResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == HTTPStatus.BAD_REQUEST:
+        response_400 = PostApiOctostarWorkspaceDataApiZipImportResponse400.from_dict(response.json())
+
+        return response_400
+    if response.status_code == HTTPStatus.FORBIDDEN:
+        response_403 = PostApiOctostarWorkspaceDataApiZipImportResponse403.from_dict(response.json())
+
+        return response_403
+    if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
+        response_500 = PostApiOctostarWorkspaceDataApiZipImportResponse500.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Client = None, response: httpx.Response
+) -> Response[
+    Union[
+        PostApiOctostarWorkspaceDataApiZipImportResponse200,
+        PostApiOctostarWorkspaceDataApiZipImportResponse400,
+        PostApiOctostarWorkspaceDataApiZipImportResponse403,
+        PostApiOctostarWorkspaceDataApiZipImportResponse500,
+    ]
+]:
+    if not client:
+        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,
+    multipart_data: PostApiOctostarWorkspaceDataApiZipImportMultipartData,
+) -> Response[
+    Union[
+        PostApiOctostarWorkspaceDataApiZipImportResponse200,
+        PostApiOctostarWorkspaceDataApiZipImportResponse400,
+        PostApiOctostarWorkspaceDataApiZipImportResponse403,
+        PostApiOctostarWorkspaceDataApiZipImportResponse500,
+    ]
+]:
+    """Uploads a zip file for extraction.
+
+     Allows clients to upload a zip file containing entities for processing, with optional parameters to
+    specify the target, whether to include content, include dashboards, and whether to overwrite
+    existing data.
+
+    Args:
+        multipart_data (PostApiOctostarWorkspaceDataApiZipImportMultipartData):
+
+    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[Union[PostApiOctostarWorkspaceDataApiZipImportResponse200, PostApiOctostarWorkspaceDataApiZipImportResponse400, PostApiOctostarWorkspaceDataApiZipImportResponse403, PostApiOctostarWorkspaceDataApiZipImportResponse500]]
+    """
+
+    if not client:
+        client = get_default_client()
+    kwargs = _get_kwargs(
+        client=client,
+        multipart_data=multipart_data,
+    )
+
+    response = httpx.request(
+        verify=client.verify_ssl,
+        **kwargs,
+    )
+    if response.is_error:
+        print(f"{str(response.status_code)} Error: {response.text} for request", str(kwargs))
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Client = None,
+    multipart_data: PostApiOctostarWorkspaceDataApiZipImportMultipartData,
+) -> Optional[
+    Union[
+        PostApiOctostarWorkspaceDataApiZipImportResponse200,
+        PostApiOctostarWorkspaceDataApiZipImportResponse400,
+        PostApiOctostarWorkspaceDataApiZipImportResponse403,
+        PostApiOctostarWorkspaceDataApiZipImportResponse500,
+    ]
+]:
+    """Uploads a zip file for extraction.
+
+     Allows clients to upload a zip file containing entities for processing, with optional parameters to
+    specify the target, whether to include content, include dashboards, and whether to overwrite
+    existing data.
+
+    Args:
+        multipart_data (PostApiOctostarWorkspaceDataApiZipImportMultipartData):
+
+    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:
+        Union[PostApiOctostarWorkspaceDataApiZipImportResponse200, PostApiOctostarWorkspaceDataApiZipImportResponse400, PostApiOctostarWorkspaceDataApiZipImportResponse403, PostApiOctostarWorkspaceDataApiZipImportResponse500]
+    """
+
+    if not client:
+        client = get_default_client()
+    return sync_detailed(
+        client=client,
+        multipart_data=multipart_data,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Client = None,
+    multipart_data: PostApiOctostarWorkspaceDataApiZipImportMultipartData,
+) -> Response[
+    Union[
+        PostApiOctostarWorkspaceDataApiZipImportResponse200,
+        PostApiOctostarWorkspaceDataApiZipImportResponse400,
+        PostApiOctostarWorkspaceDataApiZipImportResponse403,
+        PostApiOctostarWorkspaceDataApiZipImportResponse500,
+    ]
+]:
+    """Uploads a zip file for extraction.
+
+     Allows clients to upload a zip file containing entities for processing, with optional parameters to
+    specify the target, whether to include content, include dashboards, and whether to overwrite
+    existing data.
+
+    Args:
+        multipart_data (PostApiOctostarWorkspaceDataApiZipImportMultipartData):
+
+    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[Union[PostApiOctostarWorkspaceDataApiZipImportResponse200, PostApiOctostarWorkspaceDataApiZipImportResponse400, PostApiOctostarWorkspaceDataApiZipImportResponse403, PostApiOctostarWorkspaceDataApiZipImportResponse500]]
+    """
+
+    if not client:
+        client = get_default_client()
+    kwargs = _get_kwargs(
+        client=client,
+        multipart_data=multipart_data,
+    )
+
+    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,
+    multipart_data: PostApiOctostarWorkspaceDataApiZipImportMultipartData,
+) -> Optional[
+    Union[
+        PostApiOctostarWorkspaceDataApiZipImportResponse200,
+        PostApiOctostarWorkspaceDataApiZipImportResponse400,
+        PostApiOctostarWorkspaceDataApiZipImportResponse403,
+        PostApiOctostarWorkspaceDataApiZipImportResponse500,
+    ]
+]:
+    """Uploads a zip file for extraction.
+
+     Allows clients to upload a zip file containing entities for processing, with optional parameters to
+    specify the target, whether to include content, include dashboards, and whether to overwrite
+    existing data.
+
+    Args:
+        multipart_data (PostApiOctostarWorkspaceDataApiZipImportMultipartData):
+
+    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:
+        Union[PostApiOctostarWorkspaceDataApiZipImportResponse200, PostApiOctostarWorkspaceDataApiZipImportResponse400, PostApiOctostarWorkspaceDataApiZipImportResponse403, PostApiOctostarWorkspaceDataApiZipImportResponse500]
+    """
+
+    if not client:
+        client = get_default_client()
+    return (
+        await asyncio_detailed(
+            client=client,
+            multipart_data=multipart_data,
+        )
+    ).parsed

octostar-python-client-1.0.0/octostar/api/jobs/delete_job.py

@@ -0,0 +1,193 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import Client, get_default_client
+from ...models.acknowledgement import Acknowledgement
+from ...models.delete_job_response_401 import DeleteJobResponse401
+from ...models.internal_server_error import InternalServerError
+from ...models.not_found_error import NotFoundError
+from ...types import Response
+
+
+def _get_kwargs(
+    job_name: str,
+    *,
+    client: Client = None,
+) -> Dict[str, Any]:
+    if not client:
+        client = get_default_client()
+    url = "{}/api/octostar/jobs/delete/{job_name}".format(client.base_url, job_name=job_name)
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    return {
+        "method": "delete",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "follow_redirects": client.follow_redirects,
+    }
+
+
+def _parse_response(
+    *, client: Client = None, response: httpx.Response
+) -> Optional[Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]]:
+    if not client:
+        client = get_default_client()
+    if response.status_code == HTTPStatus.OK:
+        response_200 = Acknowledgement.from_dict(response.json())
+
+        return response_200
+    if response.status_code == HTTPStatus.UNAUTHORIZED:
+        response_401 = DeleteJobResponse401.from_dict(response.json())
+
+        return response_401
+    if response.status_code == HTTPStatus.NOT_FOUND:
+        response_404 = NotFoundError.from_dict(response.json())
+
+        return response_404
+    if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
+        response_500 = InternalServerError.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Client = None, response: httpx.Response
+) -> Response[Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]]:
+    if not client:
+        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(
+    job_name: str,
+    *,
+    client: Client = None,
+) -> Response[Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]]:
+    """Delete a specific job
+
+    Args:
+        job_name (str):
+
+    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[Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]]
+    """
+
+    if not client:
+        client = get_default_client()
+    kwargs = _get_kwargs(
+        job_name=job_name,
+        client=client,
+    )
+
+    response = httpx.request(
+        verify=client.verify_ssl,
+        **kwargs,
+    )
+    if response.is_error:
+        print(f"{str(response.status_code)} Error: {response.text} for request", str(kwargs))
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    job_name: str,
+    *,
+    client: Client = None,
+) -> Optional[Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]]:
+    """Delete a specific job
+
+    Args:
+        job_name (str):
+
+    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:
+        Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]
+    """
+
+    if not client:
+        client = get_default_client()
+    return sync_detailed(
+        job_name=job_name,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    job_name: str,
+    *,
+    client: Client = None,
+) -> Response[Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]]:
+    """Delete a specific job
+
+    Args:
+        job_name (str):
+
+    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[Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]]
+    """
+
+    if not client:
+        client = get_default_client()
+    kwargs = _get_kwargs(
+        job_name=job_name,
+        client=client,
+    )
+
+    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(
+    job_name: str,
+    *,
+    client: Client = None,
+) -> Optional[Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]]:
+    """Delete a specific job
+
+    Args:
+        job_name (str):
+
+    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:
+        Union[Acknowledgement, DeleteJobResponse401, InternalServerError, NotFoundError]
+    """
+
+    if not client:
+        client = get_default_client()
+    return (
+        await asyncio_detailed(
+            job_name=job_name,
+            client=client,
+        )
+    ).parsed