faculty.datasets.ls

faculty.datasets.ls(prefix='/', project_id=None, show_hidden=False, object_client=None)

List contents of project datasets.

Parameters
prefixstr, optional

List only files in the datasets matching this prefix. Default behaviour is to list all files.

project_idstr, optional

The project to list files from. You need to have access to this project for it to work. Defaults to the project set by FACULTY_PROJECT_ID in your environment.

show_hiddenbool, optional

Include hidden files in the output. Defaults to False.

object_clientfaculty.clients.object.ObjectClient, optional

Advanced - can be used to benefit from caching in chain interactions with datasets.

Returns
list

The list of files from the project datasets.