From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Pywikibot/user-config.py and the translation is 32% complete.
Other languages:
Bân-lâm-gú • ‎English • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎français • ‎português • ‎русский • ‎українська • ‎العربية • ‎中文 • ‎日本語 • ‎한국어


Перед запуском любой из программ необходимо создать файл с именем user-config.py в каталоге pywikibot. Вы создаете его одним из двух способов:

  1. Вручную Для этого нужно, чтобы хотя бы две или три переменные были настроены и размещены в правильном месте.
  2. Запустите скрипт generate_user_files.py, введя python pwb.py generate_user_files.py в командной консоли, которая будет интерактивно генерировать файл в стиле "Мастера", и сохраните его в папке конфигурации по умолчанию.


Pywikibot looks for user-config.py in the following locations, in order:

  • Specified via the -dir: argument (for example: -dir:/foo/bar)
  • The content of the environment variable PYWIKIBOT_DIR
  • The directory in which the pwb.py file is
  • In core it checks the .pywikibot directory in the application data directory (Windows) or home directory (that directory gets automatically created)

(See also: get_base_dir().)

Below are instructions for manually editing this file.

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:

Code Explanation
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 Manual: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)

For BotPasswords, refer to Manual:Pywikibot/BotPasswords.

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

Main Page: Manual: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 подключиться or pywikibot@ mailing list.