Python API Client v4.0.0

[eeberhard]

Version 4.0 of the Python API Client has been released and now supports AICA Core v5 (Enduring Eiger).

The release can be found here: https://pypi.org/project/aica-api/4.0.0/

The new version of the client is available to update or install with pip install aica-api==4.0.0. First time installs with pip install aica-api will use the latest version by default.

This major version change has the following breaking changes that are incompatible with previous usage. Please continue using version 3.x of the client for older versions of AICA Core.

Breaking Changes

The AICA constructor now takes only keyword arguments:

• url: optional, a valid URL pointing to your AICA Core instance (defaults to http://localhost:8080/api), this is different to the current url which only covers the host itself
• api_key: required, an API key with appropriate scopes
• log_level: optional, a log level from logging module (defaults to logging.INFO)

Methods of the AICA stop returning requests.Response but instead an appropriate class containing the data (or None).
A few argument types have also been changed similarly.
This allows for better type-checking, avoid using dictionary everywhere and leaving JSON parsing to the user.
Finally, nearly all exceptions are now subclasses of AICAError to allow for easier exception handling. The only exception is ValueError when calling the new load_application (allows to load application by name). The Socket.IO-based functions also raise exceptions now.

Two functions were removed: license and api_version as they aren't available through the API anymore. Moreover, component_descriptions and controller_descriptions have been deprecated in favor of extension_descriptions.

[eeberhard]

Deprecation notice: v4.0.0 and v4.0.1 of this client have been pulled from PyPi. The newest v4 client (v4.0.2 at the time of this post) should be used for AICA Core v5.1.0 and newer.

As of v4 of this client, we were using automatic code generation from our OpenAPI schema, based on openapi-python-client. Unfortunately, some parts of our API schema in AICA Core v5.0.0 and v5.0.1 were not fully compatible with the behavior of these clients, and as a result the v4.0.0 and v4.0.1 Python client versions had exceptions when calling certain endpoints.

AICA Core v5.0.0 and v5.0.1 are now unsupported by this client, and we therefore encourage users to upgrade to Core v5.1.0. Users are otherwise also able to create custom clients to interact with the API of Core v5.0.0 and v5.0.1 as necessary.