Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ This tool can be used either by passing the filenames, a category or by using a

Just list the files we want to download.

download_from_Wikimedia_Commons Example.jpg Example_ka.png
wmcdl Example.jpg Example_ka.png


### Using a category ###

Just list the files we want to download.

download_from_Wikimedia_Commons --category Example_images
wmcdl --category Example_images


### Using a file list ###
Expand All @@ -39,7 +39,7 @@ The file list must be formated as following, with one file per line, and `filena

Then use the `--list` argument:

download_from_Wikimedia_Commons --list list.txt
wmcdl --list list.txt


### Setting the output folder ###
Expand All @@ -48,14 +48,14 @@ By default, the tool downloads the files in the current directory.

This can be changed using the `--output` flag with a valid path.

download_from_Wikimedia_Commons Example.jpg --output some/path/
wmcdl Example.jpg --output some/path/


### Setting the default width

You can set the width of the thumbnail by using the `--width` argument:

download_from_Wikimedia_Commons Example.jpg --width 50
wmcdl Example.jpg --width 50


### Verbosity ###
Expand All @@ -77,4 +77,4 @@ Alternatively, you can clone the repository and install it using `setuptools`:

python setup.py install

This will install the executable script `download_from_Wikimedia_Commons`
This will install the executable script `wmcdl`
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
requires = ['argparse', 'mwclient', 'six']
entry_points = {
'console_scripts': [
'download_from_Wikimedia_Commons = commonsdownloader.commonsdownloader:main',
'wmcdl = commonsdownloader.commonsdownloader:main',
]
}

Expand Down