Skip to main content

A client utility for the AICA API

Project description

Python AICA API Client

The AICA API client module provides simple functions for interacting with the AICA API.

pip install aica-api

The client can be used to easily make API calls as shown below:

from aica_api.client import AICA
aica = AICA()

aica.set_application('my_application.yaml')
aica.start_application()

aica.load_component('my_component')
aica.unload_component('my_component')

aica.stop_application()

To check the status of component predicates and conditions, the following blocking methods can be employed:

from aica_api.client import AICA
aica = AICA()

if aica.wait_for_condition('timer_1_active', timeout=10.0):
    print('Condition is true!')
else:
    print('Timed out before condition was true')

if aica.wait_for_predicate('timer_1', 'is_timed_out', timeout=10.0):
    print('Predicate is true!')
else:
    print('Timed out before predicate was true')

Upcoming features

  • Better API documentation
  • Helper functions to handle API response objects

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aica_api-1.1.0.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

aica_api-1.1.0-py3-none-any.whl (6.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page