From 12410f41032d412e74927d5aea58039eaf8e9b50 Mon Sep 17 00:00:00 2001 From: Samer Afach Date: Sun, 13 Nov 2016 13:10:15 +0100 Subject: [PATCH] Update README.md for gitlab. --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5e69d42..081f4f8 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,14 @@ The script can be executed (globally) using: $ downloadlist.py -f file.txt -d destination -t threads -l lines where: - `file.txt` is the file name/path with the list of URLs to be downloaded - `destination` is the path, to which the files should be downloaded - `threads` is the number of processes to be used to download the URLs simultaneously - `lines` is the number of lines to read from the files and read simultaneously. 0 leads to reading the whole file. + +`file.txt` is the file name/path with the list of URLs to be downloaded (line by line) + +`destination` is the path, to which the files should be downloaded + +`threads` is the number of processes to be used to download the URLs simultaneously + +`lines` is the number of lines to read from the files and read simultaneously. 0 leads to reading the whole file. You may use the package in your own scripts by importing it: @@ -50,9 +54,12 @@ then you can download a list of files using: listdownloader.download_files(URLs, destination, num_threads) where: - `URLs` is a list of the URLs to be downloaded - `destination` is a string with the path, at which the files have to be saved - `num_threads` is the number of threads/processes to use for the download. + +`URLs` is a list of the URLs to be downloaded + +`destination` is a string with the path, at which the files have to be saved + +`num_threads` is the number of threads/processes to use for the download. You can also download a single file using the function: