m.mediawiki.org
Manual:Pywikibot/Scripts
< Manual:Pywikibot
Other languages:
English • ‎français • ‎português do Brasil • ‎русский • ‎українська • ‎中文 • ‎日本語
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 scripts/ folder. Scripts can be run in command line using the following pattern:
$ python pwb.py script_name [parameters]


Global bot scripts
Editing scripts you are allowed to run on several wikis with a global bot flag.
NameDescriptionCode
interwiki.pyCreates or modifies Interlanguage links between projectscore
redirect.pyFixes double redirects, and deletes broken redirectscore
Main bot scripts
NameDescriptionCode
add_text.pyAdds text at the top or end of pagescore
category.pyManages categoriescore
imagecopy.pyCopies images from a Wikimedia wiki to Commonscore
replace.pyEdits using text replacementcore
solve_disambiguation.pyFixes disambiguation pagescore
table2wiki.pyConverts HTML tables to MediaWiki markupcore
upload.pyUploads images to a wikicore
weblinkchecker.pyFinds broken external linkscore
Auxiliary programs
NameDescriptionCode
clean_sandbox.pyThis bot cleans a sandbox by replacing the current contents with predefined textcore
cosmetic_changes.pyMakes the wiki source code look cleaner, invoked by other scriptscore
lonelypages.pyPlace a template on pages which are not linked to by other pages, and are therefore lonelycore
selflink.pyAllows the operator to decide what to do about self linkscore
transferbot.pyA script that transfers pages from a source wiki to a target wikicore
Other bot scripts
NameDescriptionCode
copyright.pyChecks for text violating copyright by looking for matches in search enginescompattask
standardize_interwiki.pyMoves interwiki links into standard locationscore
warnfile.pycreates backlinks from an interwiki.log filecompattask
welcome.pyUsed to welcome new userscore
Administrative
NameDescriptionCode
blockpageschecker.pyDeletes any protection templates that are on pages which aren't actually protectedcore
delete.pyDeletes pages en massecore
patrol.pyThis script obtains a list of recent changes and new pages and marks the edits as patrolled based on a whitelistcore
protect.pyProtect and unprotect pages en massecore
speedy_delete.pyGoes through pages for speedy deletion, shows their content, and asks for each page whether it should be deletedcompattask
Change general pages
NameDescriptionCode
archivebot.pyArchives discussion threadscore
movepages.pyMoves page to another titlecore
pagefromfile.pyCreates pages from a text filecore
Categories
NameDescriptionCode
catall.pyAdds or changes categoriescore
category_redirect.pyRedirects pages etc. from one category to anothercore
catimages.pyImage by content categorizationcompattask
cfd.pyThis 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 themcore
commonscat.pyAdds {{commonscat}} to Wikipedia categories (or articles), if other language Wikipedia already has such templatecore
commons_link.pyAdds {{commonscat}} and {{commons}} to Wikipedia articles, if same name category or gallery exist on Commonscore
create_categories.pyProgram to batch create categoriescore
imagerecat.pyTry to find categories for media on Commonscore
imageuncat.pyProgram to add uncat template to images without categories at Commonscore
makecat.pyUses the links on a page to quickly populate a categorycore
Images
NameDescriptionCode
data_ingestion.pyA generic bot to do data ingestion (batch uploading) to Commonscore
flickrripper.pyUpload images from Flickr easilycore
imagecopy_self.pyScript to copy self published files from the English Wikipedia to Wikimedia Commonscore
imageharvest.pyCopies multiple images to a wikicore
imagetransfer.pyCopies images to another wikicore
image.pyUsed to change one image to another or remove an image entirelycore
inline_images.pyThis 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.pyThis script tags files available at Commons with the Nowcommons templatecompattask[1]
unusedfiles.pyFinds unused media using Special:Unusedimagescore
IRC scripts
IRC (Internet Relay Chat) Bots, all using the irclib, you can download it on GitHub. All scripts are experimental state.
NameDescriptionCode
maintainer.pyA wiki-maintainer script that shares tasks between workers, requires no interventioncompattask
maintcont.pyThe controller bot for maintainer.pycompattask
rciw.pyA 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.pycompattask
Templates
NameDescriptionCode
template.pyReplaces one template with another, in a way that is easier to use than replace.py in most instancescore
templatecount.pyCounts or lists the instances where templates are usedcore
Wikidata
NameDescriptionCode
claimit.pyA script to mass add Wikidata claims to a lot of items based on pages on Wikipediacore
coordinate_import.pyA script to mass import coordinates from Wikipedia to Wikidatacore
freebasemappingupload.pyA script to upload the mappings of Freebase to Wikidatacore
harvest_template.pyA script to mass add Wikidata claims based on information harvested from Wikipedia templatescore
illustrate_wikidata.pyA script to add images to Wikidata itemscore
interwikidata.pyA script to handle interwiki links: connect pages to Wikidata items using language links on the pagecore
newitem.pyA script to mass create new Wikidata itemscore
Unsorted scripts
NameDescriptionCode
capitalize_redirects.pyBot to create capitalized redirects where the first character of the first word is uppercase and the remaining characters and words are lowercasecore
casechecker.pyScript to enumerate all pages on the wiki and find all titles with mixed latin and cyrilic alphabetscore
censure.pyBad word checker botcompattask
checkimages.pyScript to check recently uploaded files. This script checks if a file description is present and if there are other problems in the image's descriptioncore
copyright_clean.pycompattask
copyright_put.pycompattask
daemonize.pycore
deledpimage.pyScript to remove EDP images in non-article namespacescompattask
disambredir.pyGoes through the disambiguation pages, checks their links, and asks for each link that goes to a redirect page whether it should be replacedcore
djvutext.pyExtracts OCR text from djvu files and uploads onto pages in the "Page" namespace on Wikisourcecore
editarticle.pyEdit a Wikipedia article with your favourite editorcore
featured.pyManage featured/good article/list status templatecore
fixing_redirects.pyCorrect all redirect links in featured pages or only one page of each wikicore
followlive.pyScript to follow new articles on a Wikipedia and tag them with a template or perform other actionscore
gui.pyA TKinter window with a Unicode text field where the user can e.g. edit the contents of an articlecore
interwiki_graph.pycore
isbn.pyThis script goes over multiple pages of the home wiki, and reports invalid ISBN numbers, converts to ISBN-13 from ISBN-10 and places hyphenscore
match_images.pyScript to match two images based on histogramscore
misspelling.pyThis script fixes links that contain common spelling mistakescore
ndashredir.pyCollect articles that have n dash or m dash character in their title and create a redirect to them from the corresponding hyphenated titlecore
noreferences.pyAdds missing <references /> tag and references section if neededcore
nowcommons.pyScript to delete files that are also present on Wikimedia Commonscore
overcat_simple_filter.pyA bot script to do some simple over categorization filteringcompattask
parserfunctioncount.pyThis script helps to find expensive templates that are subject to be converted to Luacompattask
piper.pyThis is a bot that uses external filtering programs to munge the article textcore
reflinks.pyA bot adding the title of linked web pages to bare external links; see w:en:User:DumZiBoT/refLinks by the original owner, cf. Archived Pagescore
replicate_wiki.pyThis bot replicates all pages (from specific namespaces) in a wiki to a second wiki within one familycore
revertbot.pyRevert your bots recent edits to pagescore
script_wui.pyRobot which runs python framework scripts as (sub-)bot and provides a WikiUserInterface (WUI) with Lua support for bot operatorscore
spamremove.pyScript to remove external links that are being or have been spammedcore
spellcheck.pyThis bot spellchecks wiki pagescompattask
states_redirect.pyCreate country sub-division redirect pagescore
surnames_redirects.pyBot to create redirects based on name ordercore
titletranslate.pycore
unlink.pyThis bot unlinks a page on every page that links to itcore
watchlist.pyAccess the bot account's Watchlistcore
wikisourcetext.pyThis bot applies to Wikisource sites to upload text from text layers of files in various formats, including pdfcore
Non editing scripts
Scripts which do not change wiki pages. These are allowed to run on virtually all wikis.
NameDescriptionCode
listpages.pyUsed to list pages using pagegeneratorscore
login.pyUsed to log in (and log out)core
touch.pyTouch/purge a page in order to refresh relations without waiting for the queuecore
Maintenance scripts
Helper scripts for maintenance and conversion scripts
NameDescriptionCode
cache.pyShow and cleanup API cache foldercore
colors.pyShow colored output of Pywikibot scriptscore
compat2core.pyHelper script to convert compat 1.0 scripts to the new core 3+ frameworkcore
diff_checker.pyCheck patches for known errors before submissioncore
download_dump.pyDownload Wikimedia dump file from https://dumps.wikimedia.orgcore
make_i18n_dict.pyGenerate a i18n file from a given scriptcore
wikimedia_sites.pyUpdates the language lists in Wikimedia family filescore
Other scripts
Mostly internal scripts. No normal bots.
NameDescriptionCode
basic.pyThis is not a complete bot; rather, it is a template from which simple bots can be madecore
generate_family_file.pyThis script generates a family file from a given URLcore
generate_user_files.pyScript to create user files (user-config.py, user-fixes.py)core
pwb.pyWrapper script to use framework in 'directory' mode as cronjob or wrapper scriptcore
setup.pyInstaller script for Pywikibot 3+ frameworkcore
shell.pySpawns an interactive Python shellcore
version.pyOutputs Pywikibot's revision number and Python's versioncore
Notes
Until tag_nowcommons.py will be ported to core and integrated in nowcommons.py, you can find an "unofficial" standalone core version of tag_nowcommons.py on User:XXN/tag_nowcommons.py
External links
Pywikibot package content of framework
Last edited on 26 May 2021, at 13:56
Content is available under CC BY-SA 3.0 unless otherwise noted.
Privacy policy
Terms of Use
Desktop
HomeRandomLog inSettingsDonateAbout MediaWiki.orgDisclaimers
WatchEdit