py4cytoscape.apps.get_app_status

get_app_status(app, base_url='http://127.0.0.1:1234/v1')[source]

Retrieve the current status of a Cytoscape app: Installed, Uninstalled or Disabled.

Parameters

  • app (str) – Name of app

  • base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://127.0.0.1:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

{‘appName’: <appname>, ‘status’: <status>} where <status> is Installed, Disabled or Uninstalled

Return type

dict

Raises

  • CyError – if app does not exist

  • requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> get_app_status('stringApp')
{'appName': 'stringApp', 'status': 'Installed'}