HOW TO USE THE PYTHON CONNECTOR ?

First you need to create an api key in your Braincube dashboard.

Make sure that the api key has the scopes SSO_READ and BRAINCUBE enabled.

The key should be passed to the client's configuration in order to identify yourself.

The following code guides you on how to access data for a set of variables stored on braincube:

<b>from</b> braincube_connector <b>import</b> braincube, client

bc_config = {
    "api_key": "abcd", # Use your own api key
    "domain": "mybraincube.com",
}
cli = client.get_instance(config_dict=bc_config)
parameters.set_parameter({"parse_date": <b>True</b>})
bc = braincube.get_braincube("demo")
mb = bc.get_memory_base(20)
var_list = ["2000001", "2000013", "2000015", "2000008", "2000022"]
data = mb.get_data(var_list, dataframe=<b>True</b>, label_type="name")

data will contains something like this:

1. cli = client.get_instance(config_dict=bc_config): Create a client with the credentials defined in bc_config.
2. parameters.set_parameter({"parse_date": True}): For performance reason, the braincube_connector does not parse the dates to a datetime object by default, it uses strings instead. Turning this setting to True will parse the dates in the future.
3. bc = braincube.get_braincube("demo"): Access your braincube of choice.
4. mb = bc.get_memory_base(20): Select a memory base.
5. mb.get_data(var_list, dataframe=True, label_type="name"): Get data for a set of variables referenced to by their bcIds.
   Note the two settings:
   • dataframe=True: The data are formatted into a Pandas dataframe.
   • label_type="name": The braincube_connector uses bcId as a default label for the columns of a dataframe because they are less prone to typos. When readability is the main concern "name" can be chosen for labels.