bci.client package

Submodules

bci.client.client module

bci.client.client.upload_sample(path, host=None, port=None, format=None)

Reads the sample file from path and uploads it to the server listening on host:port.

Parameters

  • path (str) – Path of the sample file.

  • host (str, optional) – Server’s IP address. Default to DEFAULT_SERVER_ACTUAL_HOST.

  • port (int, optional) – Server’s port. Default to DEFAULT_SERVER_PORT.

  • format (str, optional) – Format of the sample file. Default to DEFAULT_FORMAT

Raises

  • ValueError – If format is not supported.

  • OSError – If a failure occurs while reading the sample file.

  • requests.exceptions.RequestException – If there was an ambiguous exception that occurred while communicating with the server.

Module contents

bci.client.upload_sample(path, host=None, port=None, format=None)

Reads the sample file from path and uploads it to the server listening on host:port.

Parameters

  • path (str) – Path of the sample file.

  • host (str, optional) – Server’s IP address. Default to DEFAULT_SERVER_ACTUAL_HOST.

  • port (int, optional) – Server’s port. Default to DEFAULT_SERVER_PORT.

  • format (str, optional) – Format of the sample file. Default to DEFAULT_FORMAT

Raises

  • ValueError – If format is not supported.

  • OSError – If a failure occurs while reading the sample file.

  • requests.exceptions.RequestException – If there was an ambiguous exception that occurred while communicating with the server.