Cerebralcortex Rest Client¶

cerebralcortex_rest.client module¶

get_bucket_list(url: str, auth_token: str)[source]¶

Get buckets list from CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of object [GET] route of CC-ApiServer auth_token (str) – auth token of a user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if it fails to get buckets list

Examples

>>> from cerebralcortex_rest import get_bucket_list
>>> get_bucket_list(url="http://localhost/api/v3/bucket/default", auth_token="jwt-aut-token")

get_object(url: str, auth_token: str)[source]¶

Get object stats from CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of object (download) [GET] route of CC-ApiServer auth_token (str) – auth token of a user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if it fails to get object

Examples

>>> from cerebralcortex_rest import get_object
>>> get_object(url="http://localhost/api/v3/bucket/default/{bucket_name}/{object_name}", auth_token="jwt-aut-token")

get_objects_list_in_bucket(url: str, auth_token: str)[source]¶

Get objects list in a bucket from CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of object’s list [GET] route of CC-ApiServer auth_token (str) – auth token of a user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if it fails to get objects list in a buckets

Examples

>>> from cerebralcortex_rest import get_objects_list_in_bucket
>>> get_objects_list_in_bucket(url="http://localhost/api/v3/bucket/default/{bucket_name}", auth_token="jwt-aut-token")

get_objects_stats(url: str, auth_token: str)[source]¶

Get object stats from CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of object’s stat [GET] route of CC-ApiServer auth_token (str) – auth token of a user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if it fails to get object stats

Examples

>>> from cerebralcortex_rest import get_objects_stats
>>> get_objects_stats(url="http://localhost/api/v3/bucket/stats/default/{bucket_name}/{object_name}", auth_token="jwt-aut-token")

get_stream_data(url: str, auth_token: str)[source]¶

Get stream data from CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of user-config [GET] route of CC-ApiServer auth_token (str) – auth token of a user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if it fails to get stream data

Examples

>>> from cerebralcortex_rest import get_stream_data
>>> get_stream_data(url="http://localhost/api/v3/stream/data/default/{stream_name}", auth_token="jwt-aut-token")

get_stream_metadata(url: str, auth_token: str)[source]¶

Get stream metadata from CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of user-config [GET] route of CC-ApiServer auth_token (str) – auth token of a user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if it fails to get stream metadata

Examples

>>> from cerebralcortex_rest import get_stream_metadata
>>> get_stream_metadata(url="http://localhost/api/v3/stream/metadata/default/{stream_name}", auth_token="jwt-aut-token")

get_user_config(url: str, auth_token)[source]¶

Get user metadata from CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of user-config [GET] route of CC-ApiServer auth_token (str) – auth token of a user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if it fails to get user configs

Examples

>>> from cerebralcortex_rest import get_user_config
>>> get_user_config(url="http://localhost/api/v3/user/default/config", auth_token="jwt-auth-tocken")

login_user(url: str, username: str, password: str)[source]¶

Send credentials to CC-ApiServer and Authenticate a user. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of login route of CC-ApiServer username (str) – username password (str) – password of the user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if authentication fails

Examples

>>> from cerebralcortex_rest import login_user
>>> login_user(url="http://localhost/api/v3/user/default/login", username="demo", password="demo")

register_stream(url: str, auth_token: str, stream_metadata: str)[source]¶

Send stream metadata to CC-ApiServer for registration. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – url of stream-registration route of CC-ApiServer auth_token (str) – auth token of a user stream_metadata (dict) – metadata of the stream
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if stream registration fails

Examples

>>> from cerebralcortex_rest import register_stream
>>> register_stream(url="http://localhost/api/v3/stream/default/register", auth_token="jwt-auth-token",
                    stream_metadata={
                                  "name": "string",
                                  "description": "string",
                                  "data_descriptor": [
                                    {
                                      "name": "string",
                                      "type": "string",
                                      "attributes": [
                                        {
                                          "key": "string",
                                          "value": "string"
                                        }
                                      ]
                                    }
                                  ],
                                  "modules": [
                                    {
                                      "name": "string",
                                      "version": "string",
                                      "authors": [
                                        {
                                          "developer_name": "string",
                                          "email": "string",
                                          "attributes": [
                                            {
                                              "key": "string",
                                              "value": "string"
                                            }
                                          ]
                                        }
                                      ],
                                      "attributes": [
                                        {
                                          "key": "string",
                                          "value": "string"
                                        }
                                      ]
                                    }
                                  ]
                                })

register_user(url: str, user_metadata: dict)[source]¶

Parameters:	url (str) – url of user register route of CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist user_metadata (dict) – metadata of a user
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if user registration fails

Examples

>>> from cerebralcortex_rest import register_user
>>> register_user(url="http://localhost/api/v3/user/default/register", user_metadata={
                          "username": "string",
                          "password": "string",
                          "user_role": "string",
                          "user_metadata": {
                            "key": "string",
                            "value": "string"
                          },
                          "user_settings": {
                            "key": "string",
                            "value": "string"
                          }
                        })

upload_stream_data(url: str, auth_token: str, data_file_path: str)[source]¶

Upload stream data to cerebralcortex storage using CC-ApiServer. “default” in url is a study_name. change it if you have created a different study_name. study_name must exist

Parameters:	url (str) – base url of CerebralCortex-APIServer. For example, http://localhost/ auth_token (str) – auth token of a user data_file_path (str) – stream data file path that needs to be uploaded
Returns:	HTTP response.content
Return type:	dict
Raises:	`Exception` – if stream data upload fails

Examples

>>> from cerebralcortex_rest import upload_stream_data
>>> upload_stream_data(url="http://localhost/api/v3/stream/default/{metadata_hash}", auth_token="jwt-aut-token")