Manual:Pywikibot/Scripts

From MediaWiki.org
Jump to navigation Jump to search

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[edit]

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

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

Main bot scripts[edit]

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

Auxiliary programs[edit]

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

Other bot scripts[edit]

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

Administrative[edit]

Name Description Code
blockpageschecker.py Deletes any protection templates that are on pages which aren't actually protected core
delete.py Deletes pages en masse core
patrol.py This script obtains a list of recentchanges and newpages and marks the edits as patrolled based on a whitelist core
protect.py Protect and unprotect pages en masse core
speedy_delete.py Goes through pages for speedy deletion, shows their content, and asks for each page whether it should be deleted compattask

Change general pages[edit]

Name Description Code
archivebot.py Archives discussion threads core
movepages.py Moves page to another title core
pagefromfile.py Creates pages from a text file core

Categories[edit]

Name Description Code
catall.py Adds or changes categories core
category_redirect.py Redirects pages etc. from one category to another core
catimages.py Image by content categorization compattask
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 core
commonscat.py Adds {{commonscat}} to Wikipedia categories (or articles), if other language wikipedia already has such template core
commons_link.py Adds {{commonscat}} and {{commons}} to Wikipedia articles, if same name category or gallery exist on Commons core
create_categories.py Program to batch create categories core
imagerecat.py Try to find categories for media on Commons core
imageuncat.py Program to add uncat template to images without categories at Commons core
makecat.py Uses the links on a page to quickly populate a category core

Images[edit]

Name Description Code
data_ingestion.py A generic bot to do data ingestion (batch uploading) to Commons core
flickrripper.py Upload images from Flickr easily core
imagecopy_self.py Script to copy self published files from the English Wikipedia to Wikimedia Commons core
imageharvest.py Copies multiple images to a wiki core
imagetransfer.py Copies images to another wiki core
image.py Used to change one image to another or remove an image entirely core
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) compattask
tag_nowcommons.py This script tags files available at Commons with the Nowcommons template compattask[1]
unusedfiles.py Finds unused media using Special:Unusedimages core

IRC scripts[edit]

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

Name Description Code
maintainer.py A wiki-maintainer script that shares tasks between workers, requires no intervention compattask
maintcont.py The controller bot for maintainer.py compattask
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 compattask

Templates[edit]

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

Wikidata[edit]

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

Unsorted scripts[edit]

Name Description Code
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 core
casechecker.py Script to enumerate all pages on the wiki and find all titles with mixed latin and cyrilic alphabets core
censure.py Bad word checker bot compattask
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 core
copyright_clean.py compattask
copyright_put.py compattask
daemonize.py core
deledpimage.py Script to remove EDP images in non-article namespaces compattask
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 core
djvutext.py Extracts OCR text from djvu files and uploads onto pages in the "Page" namespace on Wikisource core
editarticle.py Edit a Wikipedia article with your favourite editor core
featured.py Manage featured/good article/list status template core
fixing_redirects.py Correct all redirect links in featured pages or only one page of each wiki core
followlive.py Script to follow new articles on a wikipedia and tag them with a template or perform other actions core
gui.py A TKinter window with a unicode text field where the user can e.g. edit the contents of an article core
interwiki_graph.py core
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 core
match_images.py Script to match two images based on histograms core
misspelling.py This script fixes links that contain common spelling mistakes core
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 core
noreferences.py Adds missing <references /> tag and references section if needed core
nowcommons.py Script to delete files that are also present on Wikimedia Commons core
overcat_simple_filter.py A bot script to do some simple over categorization filtering compattask
parserfunctioncount.py This script helps to find expensive templates that are subject to be converted to Lua compattask
piper.py This is a bot that uses external filtering programs to munge the article text core
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 core
replicate_wiki.py This bot replicates all pages (from specific namespaces) in a wiki to a second wiki within one family core
revertbot.py Revert your bots recent edits to pages core
script_wui.py Robot which runs python framework scripts as (sub-)bot and provides a WikiUserInterface (WUI) with Lua support for bot operators core
spamremove.py Script to remove external links that are being or have been spammed core
states_redirect.py Create country sub-division redirect pages core
surnames_redirects.py Bot to create redirects based on name order core
titletranslate.py core
unlink.py This bot unlinks a page on every page that links to it core
watchlist.py Access the bot account's Watchlist core
wikisourcetext.py This bot applies to wikisource sites to upload text from text layers of files in various formats, including pdf core

Non editing scripts[edit]

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

Name Description Code
listpages.py Used to list pages using pagegenerators core
login.py Used to log in core
pagegenerators.py Used to list pages using pagegenerators programmatically. listpages.py provides the same functionality as a standalone script core
touch.py Touch/purge a page in order to refresh relations and not waiting for the queue core

Maintenance scripts[edit]

Helper scripts for maintenance and conversion scripts

Name Description Code
cache.py Show and cleanup API cache folder core
colors.py Show colored output of Pywikibot scripts core
compat2core.py Helper script to convert compat 1.0 scripts to the new core 3.x framework core
diff_checker.py Check patches for known errors before submission core
download_dump.py Download Wikimedia dump file from https://dumps.wikimedia.org core
make_i18n_dict.py Generate a i18n file from a given script core
wikimedia_sites.py Updates the language lists in Wikimedia family files core

Other scripts[edit]

Mostly internal scripts. No normal bots.

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

Notes[edit]

  1. Until tag_nowcommons.py will be ported to core and integrated in nowcommons.py, an "unofficial" standalone core version of tag_nowcommons.py you can find on User:XXN/tag_nowcommons.py

External links[edit]