faculty.datasets.get

faculty.datasets.get(project_path, local_path, project_id=None, object_client=None)

Copy from a project’s datasets to the local filesystem.

Parameters
project_pathstr

The source path in the project datasets to copy.

local_pathstr or os.PathLike

The destination path in the local filesystem.

project_idstr, optional

The project to get 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.

object_clientfaculty.clients.object.ObjectClient, optional

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