diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 10 insertions, 5 deletions
@@ -11,7 +11,7 @@ Requires Python 2.7 or 3.5+. Install with `pip install --user wikiget`. ## Usage -`wikiget [-h] [-V] [-q | -v] [-f] [--site SITE] [-o OUTPUT] FILE` +`wikiget [-h] [-V] [-q | -v] [-f] [-a] [--site SITE] [-o OUTPUT] FILE` If `FILE` is in the form `File:Example.jpg` or `Example.jpg`, it will be fetched from the default site, which is "en.wikipedia.org". If it's the fully-qualified @@ -32,6 +32,11 @@ By default, the program won't overwrite existing files with the same name as the target, but this can be forced with `-f` or `--force`. Additionally, the file can be downloaded to a different name with `-o`. +Files can be batch downloaded with the `-a` or `--batch` flag. In this mode, `FILE` +will be treated as an input file containing multiple files to download, one filename +or URL per line. If an error is encountered, execution stops immediately and the +offending filename is printed. + ### Examples ```bash @@ -42,9 +47,9 @@ wikiget https://en.wikipedia.org/wiki/File:Example.jpg -o test.jpg ## Future plans -- batch download categories, user uploads, or from a text file +- batch download by (Commons) category or user uploads - download from any MediaWiki-powered site, not just Wikimedia projects -- download Wikipedia articles, in plain text, wikitext, or other formats +- maybe: download Wikipedia articles, in plain text, wikitext, or other formats ## Contributing @@ -68,8 +73,8 @@ python3 -m venv venv To activate the virtual environment, use one of the following commands: ```bash -source venv/bin/activate # Linux and macOS -.\venv\Scripts\activate # Windows +source venv/bin/activate # Linux and macOS; activate.csh and activate.fish are also available +.\venv\Scripts\activate # Windows (Command Prompt or PowerShell) ``` Then run `pip install -e .` to invoke an |