libiap 0.4.0

Python SDK/Library for IAP

libiap

Python SDK/Library for IAP -- https://umccr-illumina.github.io/libiap/

• Tested for Python 3.6, 3.7, 3.8
• Test Coverage

TL;DR

• Install through pip like so:

pip install libiap

• Export IAP base URL and auth token:

export IAP_BASE_URL=<baseUrl>
export IAP_AUTH_TOKEN=<tok>

• Somewhere in your Python code:

import os
from libiap.openapi import libwes
from libiap.openapi.libwes import WorkflowList, WorkflowCompact

iap_auth_token = os.getenv("IAP_AUTH_TOKEN")
iap_base_url = os.getenv("IAP_BASE_URL")

configuration = libwes.Configuration(
    host=iap_base_url,
    api_key={
        'Authorization': iap_auth_token
    },
    api_key_prefix={
        'Authorization': "Bearer"
    },
)

with libwes.ApiClient(configuration) as api_client:

    wfl_api: libwes.WorkflowsApi = libwes.WorkflowsApi(api_client)
    try:
        page_token = None
        while True:
            wfl_list: WorkflowList = wfl_api.list_workflows(page_size=100, page_token=page_token)
            # print(wfl_list)
            for item in wfl_list.items:
                wfl: WorkflowCompact = item
                print(wfl.id)
                print(wfl.name)
            page_token = wfl_list.next_page_token
            if not wfl_list.next_page_token:
                break
    except libwes.ApiException as e:
        print(e)

More examples available at:

• libiap.openapi documentation
• PyDoc
• Wiki

Alpha Modules Deprecation Note

🙋‍♂️ For those who just get started using libiap, please use auto-generated OpenAPI modules under libiap.openapi package (e.g. libiap.openapi.libwes, ...) for better upstream support.

• Those alpha modules directly under top level package (e.g. libiap.libwes, ...) may be deprecated in near future releases.
• These alpha modules are there for some backward compatible and graceful migration support purpose only.
• Start from release 0.4.0, you will get deprecation warning when you attempt to import or use these alpha modules.

Development

• Setup virtual environment and activate it

• Install dependencies

make install

• To run unit tests suite

make unit
make autounit

• To bring up mock API μ-services

make up

• To run integration tests suite (required services fully up)

make it

• To run full test suite (required services fully up)

make test

• Most of the dev pipelines are in Makefile workflow

License

MIT License and DISCLAIMER