Manual:Pywikibot/user-config.py

Configuration
Before you run any of the programs, you need to create a file named   in your   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.


 * 1) Run the script   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
Pywikibot looks for   in the following locations, in order:


 * Specified via the   argument (for example:  )
 * The content of the environment variable  
 * The directory in which the <tvar|4> </> file is
 * In core it checks the <tvar|5> </> directory in the application data directory (Windows) or home directory (that directory gets automatically created)

(See also: <tvar|1></>.)

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 <tvar|1> </> in the <tvar|2> </> 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

as the first line.

Add the following lines to <tvar|1> </>:

Now save  again.

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