< Manual:Pywikibot
Other languages:
Bân-lâm-gú • ‎English • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎français • ‎polski • ‎português • ‎русский • ‎українська • ‎العربية • ‎中文 • ‎日本語 • ‎한국어
Wikimedia Git repository has this file: user-config.py.sample
Before you run any of the programs, you need to create a file named user-config.py in your pywikibot directory. You create it in either of two ways:
  1. Create the file manually. It needs at least two or three variables configured, and placed in the correct location.
  2. Run the script generate_user_files.py by entering python pwb.py generate_user_files.py in a command shell, which will interactively generate the file in an interactive "wizard" style, and store it in the default configuration location.
Pywikibot looks for user-config.py in the following locations, in order:
(See also: get_base_dir().)
Below are instructions for manually editing this file.
For Wikimedia projects
Open a text editor (e.g. Notepad in Windows) and save the text file as user-config.py in the pywikibot folder.
If your language uses non-ASCII characters, you should use a Unicode-aware editor such as Notepad++ and save your user-config with Unicode encoding without BOM marks. Don't forget to insert
# -*- coding: utf-8 -*-
as the first line.
Add the following lines to user-config.py:
family = 'wikipedia'mylang = 'en'
xx is the code for the language you are working on, for example 'en' is English.[1] Family is the project name.[2]
usernames​[​'wikipedia'​][​'en'​] = 'ExampleBot'
Your user-config.py file needs to specify the bot's username.
In this example, the user is working on English Wikipedia, and has created a bot account with the username "ExampleBot". [3]
authenticate​[​'*.wikipedia.org'​] = (​'<consumer_key>'​,​'<consumer_secret>'​, '<access_key>', '<access_secret>')
This replaces password-based authentication with OAuth, which is more secure (especially for bots with shared ownership). See Pywikibot/OAuth on how to obtain the keys/secrets.
usernames​[​'wikipedia'​][​'de'​] = 'BeispielBot'​usernames​[​'wikipedia'​][​'en'​] = 'ExampleBot'​usernames​[​'wiktionary'​][​'de'​] = 'BeispielBot'
If you are working on more than one Wikimedia project, you can also add several usernames.
(Optional, and rarely needed)
console_encoding = 'utf-8'​textfile_encoding = 'unicode_escape'
If this is the encoding used by your system. Always try without first.
sort_ignore_case = True
Some scripts may use this for sorting, e.g. solve_disambiguation.py​. Default is False. Capitalized titles will preceed uncapitalized ones if this key is False or omitted, and capitalization will be disregarded by sorting if True.
usernames​[​'wikiproject'​][​'languagecode'​] = 'YourSysopUsername'
Define a sysop account for actions that require additional privileges, e.g. deleting pages.
password_file = "user-password.py"
Define a password file. The lines of the file should be tuples in any of the following formats:
(code, family, username, password)(family, username, password)(username, password)
Now save user-config.py again.
user-config.py examples
EksempelBot on no.wikipedia
mylang = 'no' usernames['wikipedia']['no'] = 'EksempelBot' console_encoding = 'utf-8' use_api_login = True
ExampleBot on Commons
mylang = 'commons' family = 'commons' usernames['commons']['commons'] = 'ExampleBot' console_encoding = 'utf-8' use_api_login = True
ExampleBot on Wikidata
mylang = 'wikidata' family = 'wikidata' usernames['wikidata']['wikidata'] = 'ExampleBot' console_encoding = 'utf-8' use_api_login = True
ExampleBot on Test wiki
mylang = 'test' family = 'test' usernames['test']['test'] = 'ExampleBot'
ExampleBot on Test2 wiki
mylang = 'test2' family = 'wikipedia' usernames['wikipedia']['test2'] = 'ExampleBot'
BeispielBot on de.wikipedia and de.wikibooks, with de.wikipedia as main wiki
mylang = 'de' usernames['wikipedia']['de'] = 'BeispielBot' usernames['wikibooks']['de'] = 'BeispielBot' console_encoding = 'utf-8' use_api_login = True
For non-Wikimedia wikis
See main page Pywikibot/Use on third-party wikis
See also
config2.py (the source code of the module that loads and interpretes user-config.py)
  1. If you want to work with more than one language, choose the most common one. You can override this on the command line by using -lang:zh parameter.
  2. Meta uses 'meta' for both language code and wiki family, Commons uses 'commons' for both, and Testwiki uses 'test' for both, the multilingual wikisource uses '-' for the language. You can override this on the command line by using -family:wikibooks.
  3. Note that on Linux/Unix hosts username capitalization matters! While logging in may not be an issue, testing the log in or attempting to use a bot will not use the correct cookie file and may result in anonymous access to the API. This can cause problems for private wikis that do not allow anonymous access or use third party authentication. Default usernames for mediawiki and those pulled via LDAP or other third party authentication schemes will have an uppercase character for the first letter, thus 'user' becomes 'User'.

If you need more help on setting up your Pywikibot visit the #pywikibot IRC channel connect or pywikibot@ mailing list.
Last edited on 7 June 2021, at 10:54
Content is available under CC BY-SA 3.0 unless otherwise noted.
Privacy policy
Terms of Use
HomeRandomLog inSettingsDonateAbout MediaWiki.orgDisclaimers