cirro-api-client 0.0.2__tar.gz → 0.0.4__tar.gz

cirro_api_client-0.0.4/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.1
+Name: cirro_api_client
+Version: 0.0.4
+Summary: A client library for accessing Cirro
+Home-page: https://github.com/CirroBio/Cirro-client-python
+License: MIT
+Keywords: Cirro
+Author: Cirro
+Author-email: support@cirro.bio
+Requires-Python: >=3.8,<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
+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)
+Project-URL: Repository, https://github.com/CirroBio/Cirro-client-python
+Description-Content-Type: text/markdown
+
+# Cirro API Client
+
+Low-level client for the Cirro API. Rather than using this package directly, we recommend using the [Cirro SDK](https://github.com/CirroBio/Cirro-client).
+
+This Python package is automatically generated by the [OpenAPI Python Client](https://github.com/openapi-generators/openapi-python-client) project:
+
+## Requirements.
+
+Python 3.8+.
+
+## Installation & Usage
+### pip install
+
+Via PyPI:
+```sh
+pip install cirro-api-client
+```
+
+You can also install it directory from the repository using:
+
+```sh
+pip install git+https://github.com/CirroBio/Cirro-client-python.git
+```
+
+## Getting Started
+
+### Basic usage
+
+```python
+import os
+from typing import List
+from pprint import pprint
+
+from cirro_api_client.v1 import CirroApiClient
+from cirro_api_client.v1.api.projects import get_projects
+from cirro_api_client.v1.models import Project
+from cirro_api_client.v1.types import Response
+
+# Create a client
+client = CirroApiClient(base_url="https://api.cirro.bio",
+                        token=os.environ['TOKEN'])
+
+# Call API endpoint, get list of projects
+projects: List[Project] = get_projects.sync(client=client)
+print("The response of get_projects:\n")
+pprint(projects)
+## or if you need more info (e.g. status_code)
+resp: Response[List[Project]] = get_projects.sync_detailed(client=client)
+projects = resp.parsed
+```
+
+### Async usage
+```python
+import os
+from typing import List
+
+from cirro_api_client.v1 import CirroApiClient
+from cirro_api_client.v1.api.projects import get_projects
+from cirro_api_client.v1.models import Project
+
+client = CirroApiClient(base_url="https://api.cirro.bio",
+                        token=os.environ['TOKEN'])
+
+# async method
+async with client as client:
+    projects: List[Project] = await get_projects.asyncio(client=client)
+```
+
+### Advanced usage
+
+There are more settings on the generated `CirroApiClient` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+import os
+from cirro_api_client.v1 import CirroApiClient
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+client = CirroApiClient(
+    base_url="https://api.cirro.bio",
+    token=os.environ['TOKEN'],
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import os
+import httpx
+from cirro_api_client.v1 import CirroApiClient
+
+client = CirroApiClient(base_url="https://api.cirro.bio",
+                        token=os.environ['TOKEN'])
+
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://api.cirro.bio", proxies="http://localhost:8030"))
+```
+
+## Developer information
+
+Re-generate the API client by running:
+
+```sh
+openapi-python-client.exe update --url https://api.cirro.bio/openapi/cirro-data-latest.yml --config config.yml --custom-template-path=templates/
+ ```

cirro_api_client-0.0.4/README.md

@@ -0,0 +1,113 @@
+# Cirro API Client
+
+Low-level client for the Cirro API. Rather than using this package directly, we recommend using the [Cirro SDK](https://github.com/CirroBio/Cirro-client).
+
+This Python package is automatically generated by the [OpenAPI Python Client](https://github.com/openapi-generators/openapi-python-client) project:
+
+## Requirements.
+
+Python 3.8+.
+
+## Installation & Usage
+### pip install
+
+Via PyPI:
+```sh
+pip install cirro-api-client
+```
+
+You can also install it directory from the repository using:
+
+```sh
+pip install git+https://github.com/CirroBio/Cirro-client-python.git
+```
+
+## Getting Started
+
+### Basic usage
+
+```python
+import os
+from typing import List
+from pprint import pprint
+
+from cirro_api_client.v1 import CirroApiClient
+from cirro_api_client.v1.api.projects import get_projects
+from cirro_api_client.v1.models import Project
+from cirro_api_client.v1.types import Response
+
+# Create a client
+client = CirroApiClient(base_url="https://api.cirro.bio",
+                        token=os.environ['TOKEN'])
+
+# Call API endpoint, get list of projects
+projects: List[Project] = get_projects.sync(client=client)
+print("The response of get_projects:\n")
+pprint(projects)
+## or if you need more info (e.g. status_code)
+resp: Response[List[Project]] = get_projects.sync_detailed(client=client)
+projects = resp.parsed
+```
+
+### Async usage
+```python
+import os
+from typing import List
+
+from cirro_api_client.v1 import CirroApiClient
+from cirro_api_client.v1.api.projects import get_projects
+from cirro_api_client.v1.models import Project
+
+client = CirroApiClient(base_url="https://api.cirro.bio",
+                        token=os.environ['TOKEN'])
+
+# async method
+async with client as client:
+    projects: List[Project] = await get_projects.asyncio(client=client)
+```
+
+### Advanced usage
+
+There are more settings on the generated `CirroApiClient` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+import os
+from cirro_api_client.v1 import CirroApiClient
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+client = CirroApiClient(
+    base_url="https://api.cirro.bio",
+    token=os.environ['TOKEN'],
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import os
+import httpx
+from cirro_api_client.v1 import CirroApiClient
+
+client = CirroApiClient(base_url="https://api.cirro.bio",
+                        token=os.environ['TOKEN'])
+
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://api.cirro.bio", proxies="http://localhost:8030"))
+```
+
+## Developer information
+
+Re-generate the API client by running:
+
+```sh
+openapi-python-client.exe update --url https://api.cirro.bio/openapi/cirro-data-latest.yml --config config.yml --custom-template-path=templates/
+ ```

cirro_api_client-0.0.4/cirro_api_client/__init__.py

@@ -0,0 +1,4 @@
+from .cirro_auth import TokenAuth
+from .cirro_client import CirroApiClient
+
+__all__ = ("CirroApiClient", "TokenAuth")

cirro_api_client-0.0.4/cirro_api_client/cirro_auth.py

@@ -0,0 +1,20 @@
+from abc import ABC
+from typing import Dict
+
+from attr import define
+
+
+class AuthMethod(ABC):
+    def get_auth_headers(self) -> Dict[str, str]:
+        """
+        The returned dict must include headers to add to authenticate properly to Cirro
+        """
+        raise NotImplementedError()
+
+
+@define
+class TokenAuth(AuthMethod):
+    token: str
+
+    def get_auth_headers(self) -> Dict[str, str]:
+        return {"Authorization": f"Bearer {self.token}"}

cirro_api_client-0.0.4/cirro_api_client/cirro_client.py

@@ -0,0 +1,59 @@
+import importlib.metadata
+import platform
+from typing import Dict
+
+from attrs import define, field
+
+from cirro_api_client.cirro_auth import AuthMethod
+from cirro_api_client.v1.client import Client
+
+
+def _get_user_agent(package_name: str, client_name: str) -> str:
+    try:
+        pkg_version = importlib.metadata.version(package_name)
+    except (importlib.metadata.PackageNotFoundError, ValueError):
+        pkg_version = "Unknown"
+    python_version = platform.python_version()
+    return f"{client_name} {pkg_version} (Python {python_version})"
+
+
+# noinspection PyUnresolvedReferences
+@define
+class CirroApiClient(Client):
+    """A class for interacting with the Cirro API
+
+    Attributes:
+        auth_method: The method used to authenticate API requests
+
+        base_url: The base URL for the API, all requests are made to a relative path to this URL
+
+        cookies: A dictionary of cookies to be sent with every request
+
+        headers: A dictionary of headers to be sent with every request
+
+        timeout: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        verify_ssl: Whether to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        follow_redirects: Whether to follow redirects. Default value is False.
+
+        httpx_args: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+        raise_on_unexpected_status: Whether to raise an errors.UnexpectedStatus if the API returns a
+                status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+                argument to the constructor.
+    """
+
+    auth_method: AuthMethod
+    raise_on_unexpected_status: bool = field(default=True, kw_only=True)
+    _client_name: str = field(init=False, default="Cirro API Client")
+    _package_name: str = field(init=False, default="cirro-api-client")
+    _user_agent: str = field(init=False)
+
+    def __attrs_post_init__(self):
+        self._user_agent = _get_user_agent(self._package_name, self._client_name)
+
+    def get_headers(self) -> Dict[str, str]:
+        return {"User-Agent": self._user_agent, **self.auth_method.get_auth_headers()}

cirro_api_client-0.0.4/cirro_api_client/v1/__init__.py

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

cirro_api_client-0.0.4/cirro_api_client/v1/api/__init__.py

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

cirro_api_client-0.0.4/cirro_api_client/v1/api/billing/create_billing_account.py

@@ -0,0 +1,168 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.billing_account_request import BillingAccountRequest
+from ...models.create_response import CreateResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: BillingAccountRequest,
+) -> Dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "post",
+        "url": "/billing",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[CreateResponse]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = CreateResponse.from_dict(response.json())
+
+        return response_200
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[CreateResponse]:
+    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: BillingAccountRequest,
+) -> Response[CreateResponse]:
+    """Create billing account
+
+     Creates a billing account
+
+    Args:
+        body (BillingAccountRequest):
+
+    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[CreateResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Client,
+    body: BillingAccountRequest,
+) -> Optional[CreateResponse]:
+    """Create billing account
+
+     Creates a billing account
+
+    Args:
+        body (BillingAccountRequest):
+
+    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:
+        CreateResponse
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+    body: BillingAccountRequest,
+) -> Response[CreateResponse]:
+    """Create billing account
+
+     Creates a billing account
+
+    Args:
+        body (BillingAccountRequest):
+
+    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[CreateResponse]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Client,
+    body: BillingAccountRequest,
+) -> Optional[CreateResponse]:
+    """Create billing account
+
+     Creates a billing account
+
+    Args:
+        body (BillingAccountRequest):
+
+    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:
+        CreateResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

cirro_api_client-0.0.4/cirro_api_client/v1/api/billing/delete_billing_account.py

@@ -0,0 +1,97 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs(
+    billing_account_id: str,
+) -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "delete",
+        "url": f"/billing/{billing_account_id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    if response.status_code == HTTPStatus.OK:
+        return None
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, 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(
+    billing_account_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Delete billing account
+
+     Deletes a billing account
+
+    Args:
+        billing_account_id (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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        billing_account_id=billing_account_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    billing_account_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Delete billing account
+
+     Deletes a billing account
+
+    Args:
+        billing_account_id (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[Any]
+    """
+
+    kwargs = _get_kwargs(
+        billing_account_id=billing_account_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

cirro_api_client-0.0.4/cirro_api_client/v1/api/billing/generate_billing_report.py

@@ -0,0 +1,81 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs() -> Dict[str, Any]:
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/billing-report",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, 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(
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Generate billing report
+
+     Generates a billing report xlsx with cost information
+
+    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()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Generate billing report
+
+     Generates a billing report xlsx with cost information
+
+    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()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)