Manual:Pywikibot/Scripts

PywikibotManual:Pywikibot
Quick overviewManual:Pywikibot/Overview Compat deprecationManual:Pywikibot/Compat/deprecation InstallationManual:Pywikibot/Installation (WindowsManual:Pywikibot/Windows) Running on LabsManual:Pywikibot/Installation/Labs user-config.pyManual:Pywikibot/user-config.py WikidataManual:Pywikibot/Wikidata Non-Wikimedia wikisManual:Pywikibot/Third-party Wiki Quick Start Basic useManual:Pywikibot/Compat/Basic use Global optionsManual:Pywikibot/Global Options i18nManual:Pywikibot/i18n ScriptsManual:Pywikibot/Scripts DevelopmentManual:Pywikibot/Development Further helpManual:Pywikibot/Communication More... »

This is a list of the existing bots with links to their descriptions. Many of the red linked scripts with no pages are found in the Pywikibot main folder.

Global bot scripts

Editing scripts you are allowed to run on several wikis with a global bot flag.

Name	Description	Compat	Core
interwiki.py	Creates or modifies Interlanguage links between projects	code	code
redirect.py	Fixes double redirects, and deletes broken redirects	code	code

Main bot scripts

Name	Description	Compat	Core
add_text.py	Adds text at the top or end of pages	code	code
category.py	Manages categories	code	code
imagecopy.py	Copies images from a wikimedia wiki to Commons	code	code
replace.py	Edits using text replacement	code	code
solve_disambiguation.py	Fixes disambiguation pages	code	code
table2wiki.py	Converts HTML tables to MediaWiki markup	code	bug (Phab task)
upload.py	Uploads images to a wiki	code	code
weblinkchecker.py	Finds broken external links	code	code

Auxiliary programs

Name	Description	Compat	Core
clean_sandbox.py	This bot cleans a sandbox by replacing the current contents with predefined text.	code	code
cosmetic_changes.py	Makes the wiki source code look cleaner, invoked by other scripts	code	code
lonelypages.py	Place a template on pages which are not linked to by other pages, and are therefore lonely	code	code
selflink.py	Allows the operator to decide what to do about self links	code	code
transferbot.py	A script that transfers pages from a source wiki to a target wiki.		code

Other bot scripts

Name	Description	Compat	Core
copyright.py	Checks for text violating copyright by looking for matches in search engines	code	bug
standardize_interwiki.py	Moves interwiki links into standard locations	code	code
warnfile.py	creates backlinks from a interwiki.log file	code	bug
welcome.py	Used to welcome new users	code	code

Administrative

Name	Description	Compat	Core
blockpageschecker.py	Deletes any protection templates that are on pages which aren't actually protected.	code	code
delete.py	Deletes pages en masse	code	code
patrol.py	This script obtains a list of recentchanges and newpages and marks the edits as patrolled based on a whitelist.	code	code
protect.py	Protect and unprotect pages en masse.	code	code
speedy_delete.py		code

Change general pages

Name	Description	Compat	Core
archivebot.py	Archives discussion threads	code	code
movepages.py	Moves page to another title	code	code
pagefromfile.py	Creates pages from a text file	code	code
standardize_notes.py	Refactors references and citations	code

Categories

Name	Description	Compat	Core
catall.py	Adds or changes categories	code	code
category_redirect.py	Redirects pages etc. from one category to another. This also includes commons_category_redirect in core.	code	code
catimages.py	Image by content categorization	code	bug
cfd.py	This script processes the Categories for discussion working page. It parses out the actions that need to be taken as a result of CFD discussions (as posted to the working page by an administrator) and performs them.	code	code
commons_category_redirect.py	This bot cleans Commons:Category:Non-empty category redirects by moving all the files, pages and categories from redirected category to the target category. For core this script is included in category-redirect.py script with -tiny option	code
commonscat.py	Adds {{commonscat}} to Wikipedia categories (or articles), if other language wikipedia already has such template	code	code
commons_link.py	Adds {{commonscat}} and {{commons}} to Wikipedia articles, if same name category or gallery exist on Commons.	code	code
imagerecat.py	Try to find categories for media on Commons	code	code
imageuncat.py	Program to add uncat template to images without categories at Commons.	code	code
makecat.py	Uses the links on a page to quickly populate a category	code	code

Images

Name	Description	Compat	Core
data_ingestion.py	A generic bot to do data ingestion (batch uploading) to Commons	code	code
delinker.py	Bot delinks and replaces images	code
flickrripper.py	Upload images from Flickr easily	code	code
imagecopy_self.py	Script to copy self published files from the English Wikipedia to Wikimedia Commons	code	code
imageharvest.py	Copies multiple images to a wiki	code	code
imagetransfer.py	Copies images to another wiki	code	code
image.py	Used to change one image to another or remove an image entirely.	code	code
inline_images.py	This bot goes over multiple pages of the home wiki, and looks for images that are linked inline (i.e., they are hosted from an external server and hotlinked, instead of using the wiki's upload function).	code	bug
panoramiopicker.py	Upload images from Panoramio easily	code	code
tag_nowcommons.py	This script tags files available at Commons with the Nowcommons template.	code	bug
unusedfiles.py	Finds unused media using Special:Unusedimages.	code	code

IRC scripts

IRC (Internet Relay Chat) Bots, all using the irclib, you can download it on Bitbucket. All scripts are experimental state.

Name	Description	Compat	Core
maintainer.py	A wiki-maintainer script that shares tasks between workers, requires no intervention	code	bug
maintcont.py	The controller bot for maintainer.py	code	bug
rciw.py	A IRC script to check for Recent Changes through IRC, and to check for interwikis in those recently modified articles. Can not be run manually/directly, but is run automatically by maintainer.py	code	bug

Templates

Name	Description	Compat	Core
template.py	Replaces one template with another, in a way that is easier to use than replace.py in most instances	code	code
templatecount.py	Counts or lists the instances where templates are used	code	code

Wikidata

Name	Description	Compat	Core
claimit.py	A script to mass add Wikidata claims to a lot of items based on pages on Wikipedia		code
coordinate_import.py	A script to mass import coordinates from Wikipedia to Wikidata		code
freebasemappingupload.py	A script to upload the mappings of Freebase to Wikidata		code
harvest_template.py	A script to mass add Wikidata claims based on information harvested from Wikipedia templates.	code	code
illustrate_wikidata.py	A script to add images to Wikidata items.		code
interwikidata.py	A script to handle interwiki links: connect pages to Wikidata items using language links on the page.		code
newitem.py	A script to mass create new Wikidata items.		code

Unsorted scripts

Name	Description	Compat	Core
capitalize_redirects.py	Bot to create capitalized redirects where the first character of the first word is uppercase and the remaining characters and words are lowercase.	code	code
casechecker.py	Script to enumerate all pages on the wiki and find all titles with mixed latin and cyrilic alphabets.	code	code
censure.py	Bad word checker bot	code	bug
checkimages.py	Script to check recently uploaded files. This script checks if a file description is present and if there are other problems in the image's description.	code	code
copyright_clean.py		code
copyright_put.py		code
create_categories.py	Program to batch create categories.	code	code
daemonize.py		code
deledpimage.py	Script to remove EDP images in non-article namespaces.	code
disambredir.py	Goes through the disambiguation pages, checks their links, and asks for each link that goes to a redirect page whether it should be replaced.	code	code
diskcache.py		code
djvutext.py	Extracts OCR text from djvu files and uploads onto pages in the "Page" namespace on Wikisource.	code	code
editarticle.py	Edit a Wikipedia article with your favourite editor.	code	code
extract_wikilinks.py		code
featured.py	Manage featured/good article/list status template.	code	code
fixing_redirects.py	Correct all redirect links in featured pages or only one page of each wiki.	code	code
followlive.py	Script to follow new articles on a wikipedia and tag them with a template or perform another actions	code
gui.py	A TKinter window with a unicode text field where the user can e.g. edit the contents of an article.	code
interwiki_graph.py		code
isbn.py	This script goes over multiple pages of the home wiki, and reports invalid ISBN numbers, converts to ISBN-13 from ISBN-10 and places hyphens.	code	code
match_images.py	Script to match two images based on histograms.	code	code
misspelling.py	This script fixes links that contain common spelling mistakes.	code	code
ndashredir.py	Collect articles that have n dash or m dash character in their title and create a redirect to them from the corresponding hyphenated title	code
noreferences.py	Adds missing <references /> tag and references section if needed	code	code
nowcommons.py	Script to delete files that are also present on Wikimedia Commons.		code
overcat_simple_filter.py	A bot script to do some simple over categorization filtering.	code
pageimport.py	This is a script to import pages from a certain wiki to another.	code
parserfunctioncount.py	This script helps to find expensive templates that are subject to be converted to Lua.	code
piper.py	This is a bot that uses external filtering programs to munge the article text.	code	code
rcsort.py	cgi script	code
reflinks.py	A bot adding the title of linked web pages to bare external links; see w:en:User:DumZiBoT/refLinks by the original owner, cf. Archived Pages.	code	code
replicate_wiki.py	This bot replicates all pages (from specific namespaces) in a wiki to a second wiki within one family.	code	code
revertbot.py	Revert your bots recent edits to pages	code	code
saveHTML.py	This bot downloads the HTML-pages of articles and images and saves the interesting parts, i.e. the article-text and the footer to a file	code
script_wui.py	Robot which runs python framework scripts as (sub-)bot and provides a WikiUserInterface (WUI) with Lua support for bot operators.		code
spamremove.py	Script to remove external links that are being or have been spammed	code	code
spellcheck.py	This bot spellchecks wiki pages.	code
states_redirect.py	Create country sub-division redirect pages		code
statistics_in_wikitable.py	This bot renders statistics provided by Special:Statistics in a table on a wiki page.	code
subster.py	Script which does substitutions of tags within wiki page content with external or other wiki text data	code
sum_disc.py	This script is used for summarize discussions spread over the whole wiki including all namespaces	code
titletranslate.py		code
udp-log.py		code
unlink.py	This bot unlinks a page on every page that links to it	code	code
us-states.py	Check pages on the English Wikipedia whether they are in the form "Something, State", and if so, create a redirect from "Something, ST".	code
watchlist.py	Access the bot account's Watchlist.	code	code
wikicomserver.py	This library allows the use of the pywikipediabot directly from COM-aware applications.	code
wikipediatools.py		code
wikisourcetext.py	This bot applies to wikisource sites to upload text.		code
wiktionary.py		code

Non editing scripts

Scripts which do not change wiki pages. These are allowed to run on virtually all wikis.

Name	Description	Compat	Core
articlenos.py	Displays the ordinal number of the new articles being created visible on the Recent Changes list.	code
get.py	Very simple script which gets a page and writes its contents to standard output. This makes it possible to pipe the text to another process.	code
listpages.py	Used to list pages using pagegenerators. Compat equivalent: pagegenerators.py and get.py		code
login.py	Used to log in	code	code
pagegenerators.py	Used to list pages using pagegenerators. Core equivalent: listpages.py	code
touch.py	Touch/purge a page in order to refresh relations and not waiting for the queue	code	code

Maintenance scripts

Helper scripts for maintenance and conversion scripts

Name	Description	Compat	Core
cache.py	Show and cleanup API cache folder		code
compat2core.py	Helper script to convert compat 1.0 scripts to the new core 2.x framework		code
make_i18n_dict.py	Generate a i18n file from a given script		code
wikimedia_sites.py	Updates the language lists in Wikimedia family files	code	code
i18n_from_json.py	Convert i18n json files inside i18n folder to i18n python files - not needed in core	code

Other scripts

Mostly internal scripts. No normal bots.

Name	Description	Compat	Core
basic.py	This is not a complete bot; rather, it is a template from which simple bots can be made.	code	code
generate_family_file.py	This script generates a family file from a given URL	code	code
generate_user_files.py	Script to create user files (user-config.py, user-fixes.py)	code	code
pwb.py	Wrapper script to use compat in 'server' mode as cronjob or wrapper script to use core in 'directory' mode	code	code
setup.py	Installer script for Pywikibot 2.0 framework		code
shell.py	Spawns an interactive Python shell		code
splitwarning.py	Splits a interwiki.log file into chunks of warnings separated by language.	code
version.py	Outputs Pywikibot's revision number and Python's version	code	code

External links

• Pywikibot package content of core branch