Details

An archive download requires specifying the identifier of the archive. The identifier tag can be found on the archive's details page. Additionally, a glob string may be specified to filter which items to download from an archive. The user must specify a location for the download to be output on disk.

The ArchiveDownloader class speeds up the downloading of an archive with a large number of files by splitting the files to download among simultaneous processes. This allows multiple files to be downloaded at the same time, increasing the total bandwidth available. By default, the ArchiveDownloader class will use 4 processes, but this number can be increased or decreased by specifying the process_num parameter.

Usage

Can be used by either running archive_downloader.py with required arguments or by importing the ArchiveDownloader class into your own program.

Class Usage

To use the class in your own code, simply from archive_downloader import ArchiveDownloader and initialize an instance of the class with the desired parameters. Call the function download_archive() to initiate the download task. Use the `set_param()` function to change the parameters before another download task.

Command Line Usage

Command Line Arguments

                        
-i, --identifier
    type=str
    Required
    Identifier of archive item to download from.
                        
                        
-o, --output_loc
    type=str
    Required
    Output location to download items to.
                        
                        
-g, --glob_str
    type=str
    Default: None
    Glob string to filter items within archive for download.
                        
                        
-p, --process_num
    type=int
    Default: 4
    Number of simultaneous download processes to run.
                        
                    

Example Command Line Usage

The command python archive_downloader.py -i example_archive_item -o C:\My_Output_Folder -g "*.jpg" -p 16 will download jpg files from "example_archive_item" to the folder "C:\My_Output_Folder" using 16 processes.