sisense package

Subpackages

• sisense.admin package
  • Subpackages
    • sisense.admin.auth package
      • Submodules
      • sisense.admin.auth.auth module
      • sisense.admin.auth.auth_model module
      • sisense.admin.auth.oauth module
      • Module contents
  • Submodules
  • sisense.admin.grafana module
  • sisense.admin.group module
  • sisense.admin.user module
  • Module contents
• sisense.analysis package
  • Submodules
  • sisense.analysis.dashboard module
  • sisense.analysis.folder module
  • sisense.analysis.widget module
  • Module contents
• sisense.data package
  • Submodules
  • sisense.data.build module
  • sisense.data.connection module
  • sisense.data.datamodel module
  • sisense.data.datasecurity module
  • sisense.data.datasource module
  • sisense.data.elasticube module
  • sisense.data.hierarchy module
  • sisense.data.permission module
  • Module contents

Submodules

sisense.api module

class sisense.api.API(host: str, version: str, token: str = None, prefix: str = 'api')

Bases: object

delete(uri: str, query: dict = None, headers: dict = None) → dict

Delete the specified resource.

Parameters:

• uri – (str) Resource identifier.
• query – (dict, default None) GET query parameters.
• headers – (dict, default None) Request headers.

Returns:

(dict) Response

download(uri: str, filepath: str, query: dict = None, headers: dict = None)

Download file from stream.

Parameters:

• uri – (str) Resource identifier.
• filepath – (str) Where to save the downloaded file, including file’s name.
• query – (dict, default None) GET query parameters.
• headers – (dict, default None) Request headers.

get(uri: str, query: dict = None, headers: dict = None) → dict

Retrieve the specified resource.

Parameters:

• uri – (str) Resource identifier.
• query – (dict, default None) GET query parameters.
• headers – (dict, default None) Request headers.

Returns:

(dict) Response

host

API’s domain name server.

patch(uri: str, data: dict = None, headers: dict = None) → dict

Update the specified resource without replacing it.

Parameters:

• uri – (str) Resource identifier.
• data – (dict, default None) Resource representation as json.
• headers – (dict, default None) Request headers.

Returns:

(dict) Response

post(uri: str, data=None, query: dict = None, headers: dict = None) → dict

Create a resource in the specified collection.

Parameters:

• uri – (str) Resource identifier.
• data – (dict or str, default None) Resource representation as json or a command as string.
• query – (dict, default None) GET query parameters.
• headers – (dict, default None) Request headers.

Returns:

(dict) Response

put(uri: str, data: dict = None, headers: dict = None) → dict

Replace the specified resource.

Parameters:

• uri – (str) Resource identifier.
• data – (dict, default None) Resource representation as json.
• headers – (dict, default None) Request headers.

Returns:

(dict) Response

upload(uri: str, file: dict, query: dict = None, headers: dict = None)

Upload a file.

Parameters:

• uri – (str) Resource identifier.
• file – (dict) {key: file-like-object File to be uploaded}.
• query – (dict, default None) GET query parameters.
• headers – (dict, default None) Request headers.

url(uri: str = '') → str

Get API’s full URL.

Parameters:uri – (str, default ‘’) Resource identifier. Returns:(str) Full url.

version

API’s version.

sisense.cli module

class sisense.cli.CLI(api: sisense.api.API, rjson: dict = None)

Bases: sisense.resource.Resource

execute(command: str)

Execute a command in the CLI.

Parameters:command – (str) Command without the “si” method. See https://documentation.sisense.com/docs/using-cli-commands. Returns:(str) Content of the call

uri

sisense.exception module

exception sisense.exception.RequestError(message: str, code: int)

Bases: Exception

sisense.resource module

class sisense.resource.Resource(api: sisense.api.API, rjson: dict = None)

Bases: object

fix_shares() → object

When API returns some resource with shares, each share has a field called ‘partyId’. However, when adding or updating this resource, the API only accepts the field ‘party’. So, this method replaces ‘partyId’ with ‘party’.

Returns:(Resource) The updated resource.

load(filepath: str) → object

Load the object representation.

Parameters:filepath – (str) Relative/absolute path to a .json file.

new(rjson: dict) → object

Create a new resource with different properties, but same API.

Parameters:rjson – (dict) Resource representation. Returns:(Resource) The new resource

save(filepath: str)

Save the object representation as a .json file.

Parameters:filepath – (str) Relative/absolute path, including filename.

sisense.sisense_client module

class sisense.sisense_client.Sisense(host: str, token: str)

Bases: object

build

Start point for build objects.

connection

Start point for connection objects.

dashboard

Start point for dashboard objects.

datamodel

Start point for datamodel objects.

datasecurity

Start point for datasecurity objects.

datasource

Start point for Datasource objects.

elasticube

Start point for elasticube objects.

folder

Start point for folder objects.

grafana

Start point for Grafana objects.

group

Start point for group objects.

hierarchy

Start point for hierarchy objects.

permission

Start point for permission objects.

user

Start point for user objects.

sisense.utils module

sisense.utils.is_json(value: str) → bool

Check if string is a JSON parsable.

Parameters:value – (str) Value to check. Returns:(bool) True, if value is a valid JSON string. False, otherwise.

sisense.utils.is_windows() → bool

Check if OS is Windows. Otherwise, assume it is linux.

Returns:(bool) True, if OS is Windows. False, otherwise.

Module contents