Pywikipediabot/upload.py
From Meta, a Wikimedia project coordination wiki
Script to upload images to wikipedia.
Contents |
[edit] Usage
python upload.py [Global-arguments] [-keep] [-filename:targetFilename] [-noverify] [URL-or-filename [description-text]]
Global arguments available for all bots
| arg | Description | Default |
|---|---|---|
| -family:xyz | Set the family of the wiki you want to work on, e.g. wikipedia, wiktionary, commons, wikitravel, …. This will override the configuration in user-config.py settings. | user-config.py parameter: family |
| -lang:xx | Set the language of the wiki you want to work on, overriding the configuration in user-config.py where xx should be the language code[1]. | user-config.py parameter: mylang |
| -log | Enable the logfile. Logs will be stored in the logs subdirectory. | user-config.py parameter: log ? |
| -log:xyz | Enable the logfile, using xyz as the filename. | |
| -nolog | Disable the logfile (if it's enabled by default). | |
| -putthrottle:nn -pt:nn |
Set the minimum time (in seconds) the bot will wait between saving pages. | user-config.py parameter: putthrottle ? |
| -verbose -v |
Make the program output more detailed messages than usual to the standard output about its current work, or progress, while it is proceeding. This may be helpful when debugging or dealing with unusual situations. | not selected |
[edit] Arguments
| -keep | Keep the filename as is |
| -filename | Target filename |
| -noverify | Do not ask for verification of the upload description if one is given |
If any other arguments are given, the first is the URL or filename to upload, and the rest is a proposed description to go with the upload. If none of these are given, the user is asked for the file or URL to upload. The bot will then upload the image to the wiki.
The script will ask for the location of an image, if not given as a parameter, and for a description.
If the -filename argument is given, then it is used as the name of the image on the wiki; otherwise it is based on the filename or url of the input file.
If -keep is not specified, then the target filename undergoes some further checking, and the user is asked for confirmation. The / character is forbidden, and the filename extension (after the dot) must be one of these: gif, jpg, jpeg, mid, midi, ogg, png, svg, xcf, djvu. If the check is failed, then the user is prompted for a new filename.
Spaces in the filename will automatically be converted to underscores, since mediawiki doesn't allow spaces. The encoding of the filename will also be converted to the encoding used on the target site (typically unicode). The script also attempts to convert the description to the wiki's target encoding, or, as a last resort, will convert characters to html entities.
Error detection is based on both the http status and the contents of the response, which is assumed to be in English; error detection may fail if the bot's account has been set not to show an English interface.
