Manual:Pywikibot/BotPasswords

As a simpler (but less secure) alternative to OAuth MediaWiki allows bot users to use Bot passwords to limit the permissions given to a bot.

When using BotPasswords each instance gets a login_name of the form  and a password. This combination can only access the API, not the normal web interface.

Requirements
Refer to T150645.
 * The wiki where you want to use the bot needs MediaWiki > 1.27
 * In most installations, the client software should be configured to use  protocol.
 * Though logins may initially appear to work, the generated cookie appears incomplete and pywikibot actions relying on rights will fail.

Configuration

 * Log in as your bot account (if it is different from your main account).
 * Generate a bot password under Special:BotPasswords (or the corresponding page on another wiki):
 * Fill in a 'bot name', which is the suffix which will be added to your username. For example 'replace-on-tools'.
 * Grant the relevant rights. For most Pywikibot scripts High-volume editing, Edit existing pages and Create, edit, and move pages are enough. If you also want to upload files with the bot, include Upload new files and Upload, replace, and move files. Leave the usage restrictions as-is. Click 'create'.
 * You will receive a message like The new password to log in with Valhallasw@my-botpassword-name is mysupersecretbotpassword Do not close this window until you saved the password in your password file (see below)


 * using  script
 * This script can manage for you the creation of a  file. Simply run , and follow the prompts. After the choice of a wiki, and entering your username, you'll be able to enter the name/pass couple created on Special:BotPasswords at the previous step. The name is the one you've chosen, the pass is the one given by the website.


 * or creating  file manually
 * In the directory where your  is, create a file called , and make it unreadable for others
 * In the file user-password.py, add a line
 * In user-config.py, add the line  . Note that you should only have you username in that file and leave out the suffix "@my-botpassword-name".


 * check that config is working
 * Run . Pywikibot should now automatically login using your bot password:

Logging in to meta:meta as Valhallasw@my-botpassword-name Logged in on meta:meta as Valhallasw.

password_file entries format
The entries in  should be tuples with 2, 3, or 4 items:


 * Used when the entry should only be used on a specific, e.g.   or.
 * Used when the entry should only be used on a specific  and , e.g.   and.
 * Used when the entry should only be used on a specific, e.g.   or.
 * Used when the entry should only be used on a specific  and , e.g.   and.
 * Used when the entry should only be used on a specific  and , e.g.   and.