pykiwiai 0.0.1__tar.gz

pykiwiai-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Jetoslabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pykiwiai-0.0.1/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.1
+Name: pykiwiai
+Version: 0.0.1
+Summary: A Python client library for accessing the Autobots API - Automate your workflows with AI-powered agents
+Home-page: https://github.com/runkailabs/autobots-python-client
+License: MIT
+Keywords: autobots,api-client,automation,ai,workflow,api
+Author: Anurag Jha
+Author-email: toanuragjha@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: attrs (>=22.2.0)
+Requires-Dist: httpx (>=0.23.0,<0.29.0)
+Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
+Project-URL: Documentation, https://github.com/runkailabs/autobots-python-client#readme
+Project-URL: Repository, https://github.com/runkailabs/autobots-python-client
+Description-Content-Type: text/markdown
+
+# pykiwiai
+A Python client library for accessing the Runkai AI API
+
+## Usage
+First, create a client:
+
+```python
+from pykiwiai import Client
+
+client = Client()  # defaults to https://api.runkai.ai
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from pykiwiai import AuthenticatedClient
+
+client = AuthenticatedClient(token="SuperSecretToken")  # defaults to https://api.runkai.ai
+```
+
+Now call your endpoint and use your models:
+
+```python
+from pykiwiai.models import MyDataModel
+from pykiwiai.api.my_tag import get_my_data_model
+from pykiwiai.types import Response
+
+with client as client:
+    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 pykiwiai.models import MyDataModel
+from pykiwiai.api.my_tag import get_my_data_model
+from pykiwiai.types import Response
+
+async with client as client:
+    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
+)
+```
+
+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 `pykiwiai.api.default`
+
+## Advanced customizations
+
+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. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from pykiwiai import Client
+
+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 = Client(
+    base_url="https://api.runkai.ai",
+    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 httpx
+from pykiwiai import Client
+
+client = Client(
+    base_url="https://api.runkai.ai",
+)
+# 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.runkai.ai", proxies="http://localhost:8030"))
+```
+
+## Building / publishing this package
+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>`
+

pykiwiai-0.0.1/README.md

@@ -0,0 +1,124 @@
+# pykiwiai
+A Python client library for accessing the Runkai AI API
+
+## Usage
+First, create a client:
+
+```python
+from pykiwiai import Client
+
+client = Client()  # defaults to https://api.runkai.ai
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from pykiwiai import AuthenticatedClient
+
+client = AuthenticatedClient(token="SuperSecretToken")  # defaults to https://api.runkai.ai
+```
+
+Now call your endpoint and use your models:
+
+```python
+from pykiwiai.models import MyDataModel
+from pykiwiai.api.my_tag import get_my_data_model
+from pykiwiai.types import Response
+
+with client as client:
+    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 pykiwiai.models import MyDataModel
+from pykiwiai.api.my_tag import get_my_data_model
+from pykiwiai.types import Response
+
+async with client as client:
+    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
+)
+```
+
+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 `pykiwiai.api.default`
+
+## Advanced customizations
+
+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. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from pykiwiai import Client
+
+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 = Client(
+    base_url="https://api.runkai.ai",
+    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 httpx
+from pykiwiai import Client
+
+client = Client(
+    base_url="https://api.runkai.ai",
+)
+# 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.runkai.ai", proxies="http://localhost:8030"))
+```
+
+## Building / publishing this package
+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>`

pykiwiai-0.0.1/pykiwiai/__init__.py

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

pykiwiai-0.0.1/pykiwiai/api/__init__.py

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

pykiwiai-0.0.1/pykiwiai/api/action_graphs/__init__.py

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

pykiwiai-0.0.1/pykiwiai/api/action_graphs/async_run_action_graph_v1_action_graphs_id_async_run_post.py

@@ -0,0 +1,293 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.action_graph_result_doc import ActionGraphResultDoc
+from ...models.body_async_run_action_graph_v1_action_graphs_id_async_run_post import (
+    BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost,
+)
+from ...models.http_validation_error import HTTPValidationError
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    id: str,
+    *,
+    body: BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost,
+    action_graph_result_id: None | str | Unset = UNSET,
+    action_graph_node_id: None | str | Unset = UNSET,
+    is_rerun_graph: bool | Unset = False,
+    is_empty_downstream_only: bool | Unset = False,
+    space_id: None | str | Unset = UNSET,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    params: dict[str, Any] = {}
+
+    json_action_graph_result_id: None | str | Unset
+    if isinstance(action_graph_result_id, Unset):
+        json_action_graph_result_id = UNSET
+    else:
+        json_action_graph_result_id = action_graph_result_id
+    params["action_graph_result_id"] = json_action_graph_result_id
+
+    json_action_graph_node_id: None | str | Unset
+    if isinstance(action_graph_node_id, Unset):
+        json_action_graph_node_id = UNSET
+    else:
+        json_action_graph_node_id = action_graph_node_id
+    params["action_graph_node_id"] = json_action_graph_node_id
+
+    params["is_rerun_graph"] = is_rerun_graph
+
+    params["is_empty_downstream_only"] = is_empty_downstream_only
+
+    json_space_id: None | str | Unset
+    if isinstance(space_id, Unset):
+        json_space_id = UNSET
+    else:
+        json_space_id = space_id
+    params["space_id"] = json_space_id
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/action_graphs/{id}/async_run".format(
+            id=quote(str(id), safe=""),
+        ),
+        "params": params,
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ActionGraphResultDoc | None | HTTPValidationError | None:
+    if response.status_code == 200:
+
+        def _parse_response_200(data: object) -> ActionGraphResultDoc | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                response_200_type_0 = ActionGraphResultDoc.from_dict(data)
+
+                return response_200_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(ActionGraphResultDoc | None, data)
+
+        response_200 = _parse_response_200(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ActionGraphResultDoc | None | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+    body: BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost,
+    action_graph_result_id: None | str | Unset = UNSET,
+    action_graph_node_id: None | str | Unset = UNSET,
+    is_rerun_graph: bool | Unset = False,
+    is_empty_downstream_only: bool | Unset = False,
+    space_id: None | str | Unset = UNSET,
+) -> Response[ActionGraphResultDoc | None | HTTPValidationError]:
+    """Async Run Action Graph
+
+    Args:
+        id (str):
+        action_graph_result_id (None | str | Unset):
+        action_graph_node_id (None | str | Unset):
+        is_rerun_graph (bool | Unset):  Default: False.
+        is_empty_downstream_only (bool | Unset):  Default: False.
+        space_id (None | str | Unset):
+        body (BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost):
+
+    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[ActionGraphResultDoc | None | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+        action_graph_result_id=action_graph_result_id,
+        action_graph_node_id=action_graph_node_id,
+        is_rerun_graph=is_rerun_graph,
+        is_empty_downstream_only=is_empty_downstream_only,
+        space_id=space_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+    body: BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost,
+    action_graph_result_id: None | str | Unset = UNSET,
+    action_graph_node_id: None | str | Unset = UNSET,
+    is_rerun_graph: bool | Unset = False,
+    is_empty_downstream_only: bool | Unset = False,
+    space_id: None | str | Unset = UNSET,
+) -> ActionGraphResultDoc | None | HTTPValidationError | None:
+    """Async Run Action Graph
+
+    Args:
+        id (str):
+        action_graph_result_id (None | str | Unset):
+        action_graph_node_id (None | str | Unset):
+        is_rerun_graph (bool | Unset):  Default: False.
+        is_empty_downstream_only (bool | Unset):  Default: False.
+        space_id (None | str | Unset):
+        body (BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost):
+
+    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:
+        ActionGraphResultDoc | None | HTTPValidationError
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        body=body,
+        action_graph_result_id=action_graph_result_id,
+        action_graph_node_id=action_graph_node_id,
+        is_rerun_graph=is_rerun_graph,
+        is_empty_downstream_only=is_empty_downstream_only,
+        space_id=space_id,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+    body: BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost,
+    action_graph_result_id: None | str | Unset = UNSET,
+    action_graph_node_id: None | str | Unset = UNSET,
+    is_rerun_graph: bool | Unset = False,
+    is_empty_downstream_only: bool | Unset = False,
+    space_id: None | str | Unset = UNSET,
+) -> Response[ActionGraphResultDoc | None | HTTPValidationError]:
+    """Async Run Action Graph
+
+    Args:
+        id (str):
+        action_graph_result_id (None | str | Unset):
+        action_graph_node_id (None | str | Unset):
+        is_rerun_graph (bool | Unset):  Default: False.
+        is_empty_downstream_only (bool | Unset):  Default: False.
+        space_id (None | str | Unset):
+        body (BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost):
+
+    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[ActionGraphResultDoc | None | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+        action_graph_result_id=action_graph_result_id,
+        action_graph_node_id=action_graph_node_id,
+        is_rerun_graph=is_rerun_graph,
+        is_empty_downstream_only=is_empty_downstream_only,
+        space_id=space_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+    body: BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost,
+    action_graph_result_id: None | str | Unset = UNSET,
+    action_graph_node_id: None | str | Unset = UNSET,
+    is_rerun_graph: bool | Unset = False,
+    is_empty_downstream_only: bool | Unset = False,
+    space_id: None | str | Unset = UNSET,
+) -> ActionGraphResultDoc | None | HTTPValidationError | None:
+    """Async Run Action Graph
+
+    Args:
+        id (str):
+        action_graph_result_id (None | str | Unset):
+        action_graph_node_id (None | str | Unset):
+        is_rerun_graph (bool | Unset):  Default: False.
+        is_empty_downstream_only (bool | Unset):  Default: False.
+        space_id (None | str | Unset):
+        body (BodyAsyncRunActionGraphV1ActionGraphsIdAsyncRunPost):
+
+    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:
+        ActionGraphResultDoc | None | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            body=body,
+            action_graph_result_id=action_graph_result_id,
+            action_graph_node_id=action_graph_node_id,
+            is_rerun_graph=is_rerun_graph,
+            is_empty_downstream_only=is_empty_downstream_only,
+            space_id=space_id,
+        )
+    ).parsed