ivcap_client 0.40.3__tar.gz

ivcap_client-0.40.3/AUTHORS.md

@@ -0,0 +1,5 @@
+# Initial version authors
+
+* Max Ott <max.ott@csiro.au>
+
+# Partial list of contributors

ivcap_client-0.40.3/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Commonwealth Scientific and Industrial Research Organisation (CSIRO) ABN 41 687 119 230
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

ivcap_client-0.40.3/PKG-INFO

@@ -0,0 +1,231 @@
+Metadata-Version: 2.1
+Name: ivcap_client
+Version: 0.40.3
+Summary: A client library for accessing an IVCAP cluster
+Author: Max Ott
+Author-email: max.ott@csiro.au
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+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.15.4,<0.24.0)
+Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
+Requires-Dist: tuspy (>=1.0.0)
+Description-Content-Type: text/markdown
+
+# ivcap_client: Python library to interact with an IVCAP Cluster
+
+A python library to interact with the published API of IVCAP. Almost
+all the code of this library is auto generated by [openapi-python-client](https://github.com/openapi-generators/openapi-python-client) from [IVCAP's](https://github.com/reinventingscience/ivcap-core/) `openapi3.json` file.
+
+> CAUTION: This README is out of date, for the moment it is better to check out
+> the examples in [examples](./examples). We'll try to fix this soon.
+
+## Usage
+
+* [Create a client](#create)
+* [Call a Service](#call)
+* [Use Models](#use)
+* [Example: Order a Service](#order)
+* [Things to know](#know)
+
+### Create a client <a name="create"></a>
+
+```python
+from ivcap_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.ivcap.net", token="JWT")
+```
+
+> Currently, the best way to get the token is to use the [ivcap cli](https://github.com/reinventingscience/ivcp-cli) and execute `ivcap context get access-token`. Obviously,
+this assumes that the current context of `ivcap` is the same as the one the above
+client is for.
+
+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
+)
+```
+
+### Call a Service and use Models<a name="call"></a>
+
+```python
+from ivcap_client.models import ServiceListRT
+from ivcap_client.api.service import service_list
+from ivcap_client.types import Response
+
+services: ServiceListRT = service_list.sync(client=client, limit=1)
+# or if you need more info (e.g. status_code)
+response: Response[ServiceListRT] = service_list.sync_detailed(client=client, limit)
+```
+
+Or do the same thing with an async version:
+
+```python
+from ivcap_client.models import ServiceListRT
+from ivcap_client.api.service import service_list
+from ivcap_client.types import Response
+
+services: ServiceListRT = await service_list.asyncio(client=client, limit=2)
+# or if you need more info (e.g. status_code)
+response: Response[ServiceListRT] = await service_list.asyncio_detailed(client=client, limit)
+```
+
+### Use Models<a name="use"></a>
+
+The above call returns a `ServiceListRT` object. To find out what attributes that contains:
+
+```python
+>>> services.to_dict().keys()
+dict_keys(['at-time', 'links', 'services'])
+```
+
+and to pretty-print the list of services:
+
+```python
+import pprint
+pp = pprint.PrettyPrinter(indent=2)
+
+>>> pp.pprint(list(map(lambda el: el.to_dict(), services.services)))
+[ { 'id': 'urn:ivcap:service:8773f79e-d46c-559a-a63c-54c4e2a9d9a1',
+    'links': { ... },
+    'name': 'infer-with-paddle-paddle',
+    'provider': { 'id': 'urn:ivcap:provider:4c65b865-df6a-4977-982a-f96b19c1fda0'}},
+  { 'id': 'urn:ivcap:service:85f4586e-af1e-5200-94ba-0be8651740ed',
+    'links': { ... },
+    'name': 'Gradient Text Image',
+    'provider': { 'id': 'urn:ivcap:provider:4c65b865-df6a-4977-982a-f96b19c1fda0'}
+}]
+```
+
+### Example: Order a Service <a name="order"></a>
+
+To get the list of parameters for a particular service, using the list of services we obtained above:
+
+```python
+from ivcap_client.api.service import service_read
+from ivcap_client.models import ServiceStatusRT
+
+exampleService:ServiceStatusRT = service_read.sync(client=client, id=services.services[0].id)
+>>> exampleService.to_dict().keys()
+dict_keys(['id', 'links', 'parameters', 'account', 'description', 'metadata', 'name', 'provider', 'tags'])
+>>> exampleService.description
+'Creates an image with a customizable text.'
+>>> pp.pprint(list(map(lambda el: el.to_dict(), exampleService.parameters)))
+[ { 'description': '',
+    'label': 'Message to display',
+    'name': 'msg',
+    'optional': False,
+    'options': [],
+    'type': 'string',
+    'unit': ''},
+  { 'description': '',
+    'label': 'Image artifact to use as background',
+    'name': 'img-art',
+    'optional': True,
+    'options': [],
+    'type': 'artifact',
+    'unit': ''},
+  { 'description': '',
+    'label': 'Image url (external) to use as background',
+    'name': 'img-url',
+    'optional': True,
+    'options': [],
+    'type': 'string',
+    'unit': ''}]
+```
+
+To order a service:
+
+```python
+from typing import List
+from ivcap_client.api.order import order_create
+from ivcap_client.models import OrderRequestT, ParameterT, OrderRequestT, OrderStatusRT
+
+img_url = 'https://juststickers.in/wp-content/uploads/2016/07/go-programming-language.png'
+service_id = 'urn:ivcap:service:85f4586e-af1e-5200-94ba-0be8651740ed'
+account_id = os.environ['IVCAP_ACCOUNT_ID']
+
+p = [
+    ParameterT(name='msg', value='Hello World'),
+    ParameterT(name='img-url', value=img_url)
+]
+req = OrderRequestT(name='test 1', parameters=p, service_id=service_id , account_id=account_id)
+order_resp = order_create.sync_detailed(client=client, json_body=req)
+order:OrderStatusRT = order_resp.parsed
+if not order:
+    raise Exception(f'Order request failed: ${order_resp.status_code}')
+
+>>> pp.pprint(order.to_dict())
+{ 'account': {'id': 'urn:ivcap:account:4c65b865-df6a-4977-982a-f96b19c1fda0'},
+  'id': 'urn:ivcap:order:cd04597a-2d55-4f1c-906c-995450f30599',
+  'links': { 'self': 'http://localhost:8080/1/orders/cd04597a-2d55-4f1c-906c-995450f30599'},
+  'name': 'test 1',
+  'ordered_at': '2023-05-03T16:31:04+10:00',
+  'parameters': [ {'name': 'msg', 'value': 'Hello World'},
+                  { 'name': 'img-url',
+                    'value': 'https://juststickers.in/wp-content/uploads/2016/07/go-programming-language.png'}],
+  'products': [],
+  'service': { 'id': 'urn:ivcap:service:85f4586e-af1e-5200-94ba-0be8651740ed',
+               'links': { 'self': 'http://localhost:8080/1/services/85f4586e-af1e-5200-94ba-0be8651740ed'}},
+  'status': 'pending'}
+
+```
+
+Later on we can check on the order:
+
+```python
+from ivcap_client.api.order import order_read
+
+ostatus = order_read.sync(client=client, id=order.id)
+>>> pp.pprint(ostatus.to_dict())
+{ 'account': {'id': 'urn:ivcap:account:4c65b865-df6a-4977-982a-f96b19c1fda0'},
+  'finished_at': '2023-05-04T00:29:19Z',
+  'id': 'urn:ivcap:order:de15958e-9575-444a-aa25-69ff259e2345',
+  'links': { ... },
+  'name': 'test 1',
+  'ordered_at': '2023-05-04T00:28:29Z',
+  'parameters': [ {'name': 'msg', 'value': 'Hello World'},
+                  { 'name': 'img-url',
+                    'value': 'https://juststickers.in/wp-content/uploads/2016/07/go-programming-language.png'}],
+  'products': [ { 'id': 'urn:ivcap:artifact:eae6aceb-aec5-4eec-a918-bd4575891168',
+                  'links': { ... },
+                  'mime-type': 'image/png',
+                  'name': 'out.png',
+                  'size': 0}],
+  'service': { 'id': 'urn:ivcap:service:85f4586e-af1e-5200-94ba-0be8651740ed',
+               'links': { ... }},
+  'started_at': '2023-05-04T00:28:45Z',
+  'status': 'succeeded'}
+
+```
+
+### Things to know<a name="know"></a>
+
+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 `ivcap_client.api.default`
+

ivcap_client-0.40.3/README.md

@@ -0,0 +1,212 @@
+# ivcap_client: Python library to interact with an IVCAP Cluster
+
+A python library to interact with the published API of IVCAP. Almost
+all the code of this library is auto generated by [openapi-python-client](https://github.com/openapi-generators/openapi-python-client) from [IVCAP's](https://github.com/reinventingscience/ivcap-core/) `openapi3.json` file.
+
+> CAUTION: This README is out of date, for the moment it is better to check out
+> the examples in [examples](./examples). We'll try to fix this soon.
+
+## Usage
+
+* [Create a client](#create)
+* [Call a Service](#call)
+* [Use Models](#use)
+* [Example: Order a Service](#order)
+* [Things to know](#know)
+
+### Create a client <a name="create"></a>
+
+```python
+from ivcap_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.ivcap.net", token="JWT")
+```
+
+> Currently, the best way to get the token is to use the [ivcap cli](https://github.com/reinventingscience/ivcp-cli) and execute `ivcap context get access-token`. Obviously,
+this assumes that the current context of `ivcap` is the same as the one the above
+client is for.
+
+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
+)
+```
+
+### Call a Service and use Models<a name="call"></a>
+
+```python
+from ivcap_client.models import ServiceListRT
+from ivcap_client.api.service import service_list
+from ivcap_client.types import Response
+
+services: ServiceListRT = service_list.sync(client=client, limit=1)
+# or if you need more info (e.g. status_code)
+response: Response[ServiceListRT] = service_list.sync_detailed(client=client, limit)
+```
+
+Or do the same thing with an async version:
+
+```python
+from ivcap_client.models import ServiceListRT
+from ivcap_client.api.service import service_list
+from ivcap_client.types import Response
+
+services: ServiceListRT = await service_list.asyncio(client=client, limit=2)
+# or if you need more info (e.g. status_code)
+response: Response[ServiceListRT] = await service_list.asyncio_detailed(client=client, limit)
+```
+
+### Use Models<a name="use"></a>
+
+The above call returns a `ServiceListRT` object. To find out what attributes that contains:
+
+```python
+>>> services.to_dict().keys()
+dict_keys(['at-time', 'links', 'services'])
+```
+
+and to pretty-print the list of services:
+
+```python
+import pprint
+pp = pprint.PrettyPrinter(indent=2)
+
+>>> pp.pprint(list(map(lambda el: el.to_dict(), services.services)))
+[ { 'id': 'urn:ivcap:service:8773f79e-d46c-559a-a63c-54c4e2a9d9a1',
+    'links': { ... },
+    'name': 'infer-with-paddle-paddle',
+    'provider': { 'id': 'urn:ivcap:provider:4c65b865-df6a-4977-982a-f96b19c1fda0'}},
+  { 'id': 'urn:ivcap:service:85f4586e-af1e-5200-94ba-0be8651740ed',
+    'links': { ... },
+    'name': 'Gradient Text Image',
+    'provider': { 'id': 'urn:ivcap:provider:4c65b865-df6a-4977-982a-f96b19c1fda0'}
+}]
+```
+
+### Example: Order a Service <a name="order"></a>
+
+To get the list of parameters for a particular service, using the list of services we obtained above:
+
+```python
+from ivcap_client.api.service import service_read
+from ivcap_client.models import ServiceStatusRT
+
+exampleService:ServiceStatusRT = service_read.sync(client=client, id=services.services[0].id)
+>>> exampleService.to_dict().keys()
+dict_keys(['id', 'links', 'parameters', 'account', 'description', 'metadata', 'name', 'provider', 'tags'])
+>>> exampleService.description
+'Creates an image with a customizable text.'
+>>> pp.pprint(list(map(lambda el: el.to_dict(), exampleService.parameters)))
+[ { 'description': '',
+    'label': 'Message to display',
+    'name': 'msg',
+    'optional': False,
+    'options': [],
+    'type': 'string',
+    'unit': ''},
+  { 'description': '',
+    'label': 'Image artifact to use as background',
+    'name': 'img-art',
+    'optional': True,
+    'options': [],
+    'type': 'artifact',
+    'unit': ''},
+  { 'description': '',
+    'label': 'Image url (external) to use as background',
+    'name': 'img-url',
+    'optional': True,
+    'options': [],
+    'type': 'string',
+    'unit': ''}]
+```
+
+To order a service:
+
+```python
+from typing import List
+from ivcap_client.api.order import order_create
+from ivcap_client.models import OrderRequestT, ParameterT, OrderRequestT, OrderStatusRT
+
+img_url = 'https://juststickers.in/wp-content/uploads/2016/07/go-programming-language.png'
+service_id = 'urn:ivcap:service:85f4586e-af1e-5200-94ba-0be8651740ed'
+account_id = os.environ['IVCAP_ACCOUNT_ID']
+
+p = [
+    ParameterT(name='msg', value='Hello World'),
+    ParameterT(name='img-url', value=img_url)
+]
+req = OrderRequestT(name='test 1', parameters=p, service_id=service_id , account_id=account_id)
+order_resp = order_create.sync_detailed(client=client, json_body=req)
+order:OrderStatusRT = order_resp.parsed
+if not order:
+    raise Exception(f'Order request failed: ${order_resp.status_code}')
+
+>>> pp.pprint(order.to_dict())
+{ 'account': {'id': 'urn:ivcap:account:4c65b865-df6a-4977-982a-f96b19c1fda0'},
+  'id': 'urn:ivcap:order:cd04597a-2d55-4f1c-906c-995450f30599',
+  'links': { 'self': 'http://localhost:8080/1/orders/cd04597a-2d55-4f1c-906c-995450f30599'},
+  'name': 'test 1',
+  'ordered_at': '2023-05-03T16:31:04+10:00',
+  'parameters': [ {'name': 'msg', 'value': 'Hello World'},
+                  { 'name': 'img-url',
+                    'value': 'https://juststickers.in/wp-content/uploads/2016/07/go-programming-language.png'}],
+  'products': [],
+  'service': { 'id': 'urn:ivcap:service:85f4586e-af1e-5200-94ba-0be8651740ed',
+               'links': { 'self': 'http://localhost:8080/1/services/85f4586e-af1e-5200-94ba-0be8651740ed'}},
+  'status': 'pending'}
+
+```
+
+Later on we can check on the order:
+
+```python
+from ivcap_client.api.order import order_read
+
+ostatus = order_read.sync(client=client, id=order.id)
+>>> pp.pprint(ostatus.to_dict())
+{ 'account': {'id': 'urn:ivcap:account:4c65b865-df6a-4977-982a-f96b19c1fda0'},
+  'finished_at': '2023-05-04T00:29:19Z',
+  'id': 'urn:ivcap:order:de15958e-9575-444a-aa25-69ff259e2345',
+  'links': { ... },
+  'name': 'test 1',
+  'ordered_at': '2023-05-04T00:28:29Z',
+  'parameters': [ {'name': 'msg', 'value': 'Hello World'},
+                  { 'name': 'img-url',
+                    'value': 'https://juststickers.in/wp-content/uploads/2016/07/go-programming-language.png'}],
+  'products': [ { 'id': 'urn:ivcap:artifact:eae6aceb-aec5-4eec-a918-bd4575891168',
+                  'links': { ... },
+                  'mime-type': 'image/png',
+                  'name': 'out.png',
+                  'size': 0}],
+  'service': { 'id': 'urn:ivcap:service:85f4586e-af1e-5200-94ba-0be8651740ed',
+               'links': { ... }},
+  'started_at': '2023-05-04T00:28:45Z',
+  'status': 'succeeded'}
+
+```
+
+### Things to know<a name="know"></a>
+
+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 `ivcap_client.api.default`

ivcap_client-0.40.3/pyproject.toml

@@ -0,0 +1,46 @@
+[tool.poetry]
+name = "ivcap_client"
+version = "0.40.3"
+description = "A client library for accessing an IVCAP cluster"
+
+authors = ["Max Ott <max.ott@csiro.au>",
+            "openapi-python-client <https://github.com/openapi-generators/openapi-python-client>"]
+
+readme = "README.md"
+
+include = ["CHANGELOG.md", "src/ivcap_sdk_client/py.typed"]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+httpx = ">=0.15.4,<0.24.0"
+attrs = ">=21.3.0"
+python-dateutil = "^2.8.0"
+tuspy = ">=1.0.0"
+
+[tool.poetry.dev-dependencies]
+
+[tool.poetry.group.dev.dependencies]
+openapi-python-client = ">=0.15.0"
+pytest = "^7.1.3"
+pytest-cov = "^4.1.0"
+Sphinx = "^5.2.3"
+myst-nb = "^0.17.1"
+autoapi = "^2.0.1"
+sphinx-autoapi = "^2.0.0"
+sphinx-rtd-theme = "^1.0.0"
+licenseheaders = "^0.8.8"
+
+[tool.semantic_release]
+version_variable = "pyproject.toml:version" # version location
+branch = "main"                             # branch to make releases of
+changelog_file = "CHANGELOG.md"             # changelog file
+build_command = "poetry build"              # build dists
+dist_path = "dist/"                         # where to put dists
+upload_to_release = true                    # auto-create GitHub release
+upload_to_pypi = false                      # don't auto-upload to PyPI
+remove_dist = false                         # don't remove dists
+patch_without_tag = true                    # patch release by default
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

ivcap_client-0.40.3/src/ivcap_client/__init__.py

@@ -0,0 +1,26 @@
+#
+# Copyright (c) 2023 Commonwealth Scientific and Industrial Research Organisation (CSIRO). All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file. See the AUTHORS file for names of contributors.
+#
+""" A client library for accessing IVCAP """
+
+# read version from installed package
+try:  # Python < 3.10 (backport)
+    from importlib_metadata import version
+except ImportError:
+    from importlib.metadata import version
+try:
+    __version__ = version("ivcap_client")
+except Exception:
+    __version__ = "???" # should only happen when running the local examples
+
+from .ivcap import IVCAP, URN
+from .service import Service
+from .order import Order
+from .artifact import Artifact
+# from .metadata import Metadata
+
+# __all__ = (
+#     "IVCAP",
+# )

ivcap_client-0.40.3/src/ivcap_client/api/__init__.py

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