Project libraries

class dataikuapi.dss.projectlibrary.DSSLibrary(client, project_key)

A handle to manage the library of a project It saves locally a copy of taxonomy to help navigate in the library All modifications done through this object and related library items are done locally and on remote.

Note

Taxonomy modifications done outside this library are not reflected locally. You should reload the library in this case.

list(folder_path='/')

Lists the contents in the given library folder or on the root if no folder is given.

Parameters:

folder_path (str) – the folder path (optional). If no path is given, it is defaulted to the root path.

Returns:

the list of contents in the library folder

Return type:

list of dataikuapi.dss.projectlibrary.DSSLibraryItem

get_file(path)

Retrieves a file in the library

Parameters:

path (str) – the file path

Returns:

the file in the given path

Return type:

dataikuapi.dss.projectlibrary.DSSLibraryFile

get_folder(path)

Retrieves a folder in the library

Parameters:

path (str) – the folder path

Returns:

the folder in the given path

Return type:

dataikuapi.dss.projectlibrary.DSSLibraryFolder

add_file(file_name)

Create a file in the library root folder

Parameters:

file_name (str) – the file name

Returns:

the new file

Return type:

dataikuapi.dss.projectlibrary.DSSLibraryFile

add_folder(folder_name)

Create a folder in the library root folder

Parameters:

file_name (str) – the file name

Returns:

the new folder

Return type:

dataikuapi.dss.projectlibrary.DSSLibraryFolder