cloudblue/connect-python-openapi-client

Connect API Client based on the OpenAPI specification for Python 3.7+

Connect Python OpenAPI Client

Introduction

Connect Python OpenAPI Client is the simple, concise, powerful and REPL-friendly CloudBlue Connect API client.

It has been designed following the fluent interface design pattern.

Due to its REPL-friendly nature, using the CloudBlue Connect OpenAPI specifications it allows developers to learn and play with the CloudBlue Connect API using a python REPL like jupyter or ipython.

Install

Connect Python OpenAPI Client requires python 3.8 or later.

Connect Python OpenAPI Client can be installed from pypi.org using pip:

$ pip install connect-openapi-client

Development

We use isort library to order and format our imports, and black - to format the code. We check it using flake8-isort and flake8-black libraries (automatically on flake8 run).
For convenience you may run isort . && black . to format the code.

Documentation

Connect Python OpenAPI Client documentation is hosted on the Read the Docs service.

License

Connect Python OpenAPI Client is released under the Apache License Version 2.0.

connect-python-openapi-client's Issues

Should different filter approach be used for AsyncConnectClient?

Context: I am implementing demo extension that will automatically approve all incoming requests. The approve action requires template_id to be provided, so if there is one template - I do not want to hardcode the template id.

Using the async libraries, looks like the filters do not work on templates.

Consider the following code:

# export API_KEY="ApiKey ..."
# python test_filter.py
[{'id': 'TL-843-435-779'}]
[{'id': 'TL-843-435-779'}, {'id': 'TL-125-264-717'}, {'id': 'TL-790-939-369'}, {'id': 'TL-498-000-563'}]

test_filter.py runs the same query on sync and async clients. The query retrieves templates by type "fulfillment":

from os import environ

import asyncio

from connect.client import ConnectClient, AsyncConnectClient

product_id = "PRD-620-226-877"
api_key = environ.get("API_KEY")


def run_sync():
    c = ConnectClient(api_key)
    return list(c.products[product_id].templates.filter(type="fulfillment").values_list("id"))


def run_async():
    c = AsyncConnectClient(api_key)

    async def get_templates():
        return list([_ async for _ in c.products[product_id].templates.filter(type="fulfillment").values_list("id")])

    return asyncio.run(get_templates())


if __name__ == "__main__":
    print(run_sync())
    print(run_async())

Am I using the filters incorrectly in asynchronous approach?