Manual:Pywikibot/pagefromfile.py

From MediaWiki.org
Jump to: navigation, search
Wikimedia-logo-meta.png

This page was moved from MetaWiki.
It probably requires cleanup – please feel free to help out. In addition, some links on the page may be red; respective pages might be found at Meta. Remove this template once cleanup is complete.

Language: English  • العربية • français • italiano • 日本語
Bug blank.svg
Git repository of Wikimedia has this file:

Pagefromfile.py is part of the Pywikipedia bot framework.
With this script you can create pages from a textfile.
The file should be in UTF-8 and if you want to create multiple pages from a file you should separate the articles as specified by the -start and -end arguments.

The pagename will be the first headword in your textfile (the first word between ''' '''). It is currently automatically inserted in the uploaded page.

WARNING: the script parses the input text in a recursive way, so it can easily run out of memory if the text contains several pages. It is advisable to break the input text into single pages and upload them individually.

Specific arguments:

arg Description Default
-start:xxxx Specify the text that is the beginning of a page {{-start-}}
-end:yyyy Specify the text that is the end of a page {{-stop-}}
-file:zzz Give the filename we are getting our material from dict.txt
-include The beginning and end text should be included in the page. do not include
-notitle Do not include the title line in the page. include title line
-titlestart:xxx Use xxx in place of ''' for identifying the beginning of the page title '''
-titleend:xxx Use xxx in place of ''' for identifying the end of the page title '''
-summary:xxx Use xxx as the summary for the upload. (a translation of) "Automated import of articles"
-autosummary Use mediawiki default summary not selected
-minor Set minor edit flag on page edits. not selected
-simulate Do not really upload pages, just check and report messages. not selected
-safe If the page to be uploaded already exists, do nothing, i.e. skip it. -safe
-appendtop If the page to be uploaded already exists, add the text to the top of it.
-appendbottom If the page to be uploaded already exists, add the text to the bottom of it.
-force If the page to be uploaded already exists, overwrite the existing page.

E.g.: Filename.txt

xxxx
'''PageName'''
Text here

yyyy
xxxx
'''AnotherPageName'''
Another text
yyyy

Usage:

pagefromfile.py [global-arguments] -start:xxxx -end:yyyy -file:Filename.txt

Global arguments available for all bots

arg Description Default compat core
-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. user-config.py parameter: mylang
-family:xyz Set the family of the wiki you want to work on, e.g. wikipedia, wiktionary, commons, wikitravel, …. This will override the configuration in user-config.py settings. user-config.py parameter: family
-user:xyz Log in as user 'xyz' instead of the default username.
-daemonize:xyz Immediately return control to the terminal and redirect stdout and stderr to xyz (only use for bots that require no input from stdin).
-help Show a help text for the invoked script.
-log Enable the logfile. Logs will be stored in the logs subdirectory. user-config.py parameter: log ?
-log:xyz Enable the logfile, using xyz as the filename.
-nolog Disable the logfile (if it's 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
-debug:item
-debug
Enable the logfile and include extensive debugging data for component "item" (for all components if the second form is used).
-putthrottle:nn
-pt:nn
Set the minimum time (in seconds) the bot will wait between saving pages. user-config.py parameter: put_throttle
-verbose
-v
Make the program output more detailed messages than usual to the standard output about its current work, or progress, while it is proceeding. This may be helpful when debugging or dealing with unusual situations. not selected