download_project

Mechanical.download_project(extensions=None, target_dir=None, progress_bar=False)

Download all project files in the working directory of the Mechanical instance.

It downloads them from the working directory to the target directory. It returns the list of local file paths for the downloaded files.

Parameters:

extensionslist[str], tuple[str], optional

List of extensions for filtering files before downloading them. The default is None.

target_dirstr, optional

Path for downloading the files to. The default is None.

progress_barbool, optional

Whether to show a progress bar using tqdm. The default is False. A progress bar is helpful for viewing download progress.

Returns:

List[str]

List of local file paths.

Examples

Download all the files in the project.

>>> local_file_path_list = mechanical.download_project()