Manual:Pywikibot/generate user files.py

Pywikibot scripts
Quick overview Installation Running on PAWS Running on Windows Running on Toolforge Configuration and scripts user-config.py Global options Generator and filter options i18n Scripts Uses Wikidata Non-Wikimedia wikis Development Further help More... »

generate_user_files.py is a Pywikibot script used to create one or two user files:

1. user-config.py
2. user-fixes.py

Output

Example of output using Windows:

You can abort at any time by pressing ctrl-c

Your default user directory is "C:\pywikibot"
 1: commons
 2: i18n
 3: incubator
 4: lyricwiki
 5: mediawiki
 6: meta
 7: omegawiki
 8: osm
 9: outreach
10: species
11: strategy
12: test
13: vikidia
14: wikia
15: wikiapiary
16: wikibooks
17: wikidata
18: wikimania
19: wikimediachapter
20: wikinews
21: wikipedia
22: wikiquote
23: wikisource
24: wikitech
25: wikiversity
26: wikivoyage
27: wiktionary
28: wowwiki
Select family of sites we are working on, just enter the number or name (default: wikipedia):

Global arguments available

These options will override the configuration in user-config.py settings.

Global options

Parameter	Description	Config variable
‑dir:PATH	Read the bot's configuration data from directory given by PATH, instead of from the default directory.	-
‑lang:xx	Set the language of the wiki you want to work on, overriding the configuration in user-config.py. xx should be the language code.	mylang
‑family:xyz	Set the family of the wiki you want to work on, e.g. wikipedia, wiktionary, wikitravel, ... This will override the configuration in user-config.py.	family
‑user:xyz	Log in as user 'xyz' instead of the default username.	usernames
‑daemonize:xyz	Immediately return control to the terminal and redirect stdout and stderr to file xyz. (only use for bots that require no input from stdin).	-
‑help	Show the help text.	-
‑log	Enable the log file, using the default filename 'script_name-bot.log' Logs will be stored in the logs subdirectory.	log
‑log:xyz	Enable the log file, using 'xyz' as the filename.	logfilename
‑nolog	Disable the log file (if it is enabled by default).	-
‑maxlag	Sets a new maxlag parameter to a number of seconds. Defer bot edits during periods of database server lag. Default is set by config.py	maxlag
‑putthrottle:n ‑pt:n ‑put_throttle:n	Set the minimum time (in seconds) the bot will wait between saving pages.	put_throttle
‑debug:item ‑debug	Enable the log file and include extensive debugging data for component "item" (for all components if the second form is used).	debug_log
‑verbose ‑v	Have the bot provide additional console output that may be useful in debugging.	verbose_output
‑cosmeticchanges ‑cc	Toggles the cosmetic_changes setting made in config.py or user-config.py to its inverse and overrules it. All other settings and restrictions are untouched.	cosmetic_changes
‑simulate	Disables writing to the server. Useful for testing and debugging of new code (if given, doesn't do any real changes, but only shows what would have been changed).	simulate
‑<config var>:n	You may use all given numeric config variables as option and modify it with command line.	-