py4cytoscape.cytoscape_system.cytoscape_ping

cytoscape_ping(base_url='http://127.0.0.1:1234/v1')[source]

Ping Cytoscape

Tests the connection to Cytoscape via CyREST and verifies that supported versions of Cytoscape and CyREST API are loaded.

Parameters

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

None

Raises

  • CyError – if error connecting to CyREST or version is unsupported

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

Examples

>>> cytoscape_ping()
You are connected to Cytoscape!