py4cytoscape.collections.get_collection_list

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

Get Collection List.

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://localhost:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

list of collection names, one for each collection

Return type

list

Raises

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

Examples

>>> get_collection_list()
[]
>>> get_collection_list()
['galFiltered.sif', 'BINDyeast.sif']