Manual:Pywikibot/user-config.py

From MediaWiki.org
Jump to: navigation, search
Crystal Clear action run.svg
Generate pywikibot/user-config.py
by running generate_user_files.py.
Git-logo.svg
Wikimedia Git repository has this file:user-config.py.sample
If you need more help on setting up your Pywikibot visit the IRC channel #pywikibotconnect @ freenode server or Pywikibot mailing list.

Configuration[edit]

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.

Location[edit]

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 PYWIKIBOT2_DIR
  • The directory in which the pwb.py file is
  • In core it checks the .pywikibot directory in the application data directory (Windows) or (that directory gets automatically created)

(See also: get_base_dir().)

Below are instructions for manually editing this file.

For Wikimedia projects[edit]

Open a text editor (e.g. Notepad in Windows) and save the text file as user-config.py in the pywikipedia 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'] = u'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] [4]

(Optional)

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.

(Optional)

usernames['wikipedia']['de'] = u'BeispielBot'
usernames['wikipedia']['en'] = u'ExampleBot'
usernames['wiktionary']['de'] = u'BeispielBot'

(Optional)

If you are working on more than one Wikimedia project, you can also add several usernames.

(Optional)

console_encoding = 'utf-8'
textfile_encoding = 'unicode_escape'

(Optional, and rarely needed)

If this is the encoding used by your system. Always try without first.

(Optional)

sort_ignore_case = True

(Optional)

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.

Now save user-config.py again.

user-config.py examples[edit]

EksempelBot on no.wikipedia[edit]

mylang = 'no'
usernames['wikipedia']['no'] = u'EksempelBot'

console_encoding = 'utf-8'
use_api_login = True

ExampleBot on Commons[edit]

mylang = 'commons'
family = 'commons'
usernames['commons']['commons'] = u'ExampleBot'

console_encoding = 'utf-8'
use_api_login = True

ExampleBot on Wikidata[edit]

mylang = 'wikidata'
family = 'wikidata'
usernames['wikidata']['wikidata'] = u'ExampleBot'

console_encoding = 'utf-8'
use_api_login = True

ExampleBot on Test wiki[edit]

mylang = 'test'
family = 'test'
usernames['test']['test'] = u'ExampleBot'

ExampleBot on Test2 wiki[edit]

mylang = 'test2'
family = 'wikipedia'
usernames['wikipedia']['test2'] = u'ExampleBot'

BeispielBot on de.wikipedia and de.wikibooks, with de.wikipedia as main wiki[edit]

mylang = 'de'
usernames['wikipedia']['de'] = u'BeispielBot'
usernames['wikibooks']['de'] = u'BeispielBot'

console_encoding = 'utf-8'
use_api_login = True

For non-Wikimedia wikis[edit]

Main Page: Manual:Pywikibot/Use on third-party wikis

Notes[edit]

  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. The 'u' in front of the username stands for Unicode. The 'u' is required if your username contains non-ASCII characters.
  4. 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'.
Language:Project:Language policy English  • Tiếng Việt