visbrain.io.download_file¶
-
visbrain.io.
download_file
(name, astype=None, filename=None, to_path=None, unzip=False, remove_archive=False, use_pwd=False)[source][source]¶ Download a file.
By default this function download a file to ~/visbrain_data.
- Parameters
- namestring
Name of the file to download or url.
- astypestr | None
If name is a name of a file that can be downloaded, astype refer to the type of the file.
- filenamestring | None
Name of the file to be saved in case of url.
- to_pathstring | None
Download file to the path specified.
- unzipbool | False
Unzip archive if needed.
- remove_archivebool | False
Remove archive after unzip.
- use_pwdbool | False
Download the file to the current directory.
- Returns
- path_to_filestring
Path to the downloaded file.