boulderopalscaleup.QctrlScaleUpClient._\_init_\_

QctrlScaleUpClient.__init__(organization_slug=None, api_key=None, local_mode=False, api_url='scaleup.api.q-ctrl.com', runtime=None)

Initialize the client.

Parameters

  • organization_slug (str or None , optional) – The name of the organization using the Scale Up API. If not provided, the value is retrieved from the environment variable QCTRL_SCALE_UP_ORGANIZATION_SLUG.
  • api_key (str or None , optional) – The API key for authenticating with the Q-CTRL server. If not provided, the key is retrieved from the environment variable QCTRL_API_KEY.
  • api_url (str , optional) – The URL of the Boulder Opal Scale Up server. Defaults to the value of SERVER_URL.
  • local_mode (bool , optional) – If True, uses a local unauthenticated server. Defaults to False.
  • runtime (Runtime or None , optional) – The runtime instance to use for executing programs.

Raises

RuntimeError – If no API key or organization slug is provided and the corresponding environment variable is not set.

Was this useful?