pywikibot-scripts 11.0.0
Pywikibot Scripts Collection
License: MIT License
Requires Python: >=3.9.0
Keywords: add text, archivebot, basic, bot, client, framework, mediawiki, pwb, pybot, python, pywiki, pywikibase, pywikibot, pywikipedia, pywikipediabot, replace, redirect, script, scripts, upload, wiki, wikibase, wikidata, wikimedia, wikipedia

.. image:: https://img.shields.io/pypi/pyversions/pywikibot-scripts.svg
   :alt: Python
   :target: https://www.python.org/downloads/
.. image:: https://img.shields.io/github/languages/top/wikimedia/pywikibot
   :alt: Top language
   :target: https://www.python.org/downloads/
.. image:: https://img.shields.io/pypi/v/pywikibot-scripts.svg
   :alt: Pywikibot-scripts release
   :target: https://pypi.org/project/pywikibot-scripts/
.. image:: https://img.shields.io/pypi/wheel/pywikibot-scripts
   :alt: wheel
   :target: https://pypi.org/project/pywikibot-scripts/
.. image:: https://static.pepy.tech/badge/pywikibot-scripts
   :alt: Total downloads
   :target: https://pepy.tech/project/pywikibot-scripts
.. image:: https://static.pepy.tech/personalized-badge/pywikibot-scripts?period=month&units=international_system&left_color=black&right_color=blue&left_text=monthly
   :alt: Monthly downloads
   :target: https://pepy.tech/project/pywikibot-scripts
.. image:: https://img.shields.io/github/last-commit/wikimedia/pywikibot
   :alt: Last commit
   :target: https://gerrit.wikimedia.org/r/plugins/gitiles/pywikibot/core/

###########################################################################
**This is a package to include robots for MediaWiki wikis like Wikipedia.**
###########################################################################

.. role:: api

*********************************
Some example robots are included.
*********************************

These programs can actually modify the live wiki on the net, and proper
wiki-etiquette should be followed before running it on any wiki.

To get started on proper usage of the bot framework, refer to `Manual:Pywikibot <https://www.mediawiki.org/wiki/Manual:Pywikibot>`_.

***************************
The contents of the package
***************************

Bots and scripts
================

+--------------------------+---------------------------------------------------------+
| Bots and Scripts                                                                   |
+==========================+=========================================================+
| add_text.py              | Adds text at the top or end of pages.                   |
+--------------------------+---------------------------------------------------------+
| archivebot.py            | Archives discussion threads.                            |
+--------------------------+---------------------------------------------------------+
| basic.py                 | Is a template from which simple bots can be made.       |
+--------------------------+---------------------------------------------------------+
| blockpagechecker.py      | Deletes any protection templates that are on pages      |
|                          | which aren't actually protected.                        |
+--------------------------+---------------------------------------------------------+
| category.py              | Add a category link to all pages mentioned on a page,   |
|                          | change or remove category tags.                         |
+--------------------------+---------------------------------------------------------+
| category_graph.py        | Visualizes category hierarchy                           |
+--------------------------+---------------------------------------------------------+
| category_redirect.py     | Maintain category redirects and replace links to        |
|                          | redirected categories.                                  |
+--------------------------+---------------------------------------------------------+
| change_pagelang.py       | Changes the content language of pages.                  |
+--------------------------+---------------------------------------------------------+
| checkimages.py           | Check recently uploaded files. Checks if a file         |
|                          | description is present and if there are other problems  |
|                          | in the image's description.                             |
+--------------------------+---------------------------------------------------------+
| claimit.py               | Adds claims to Wikidata items based on categories.      |
+--------------------------+---------------------------------------------------------+
| clean_sandbox.py         | This bot resets a sandbox with predefined text.         |
+--------------------------+---------------------------------------------------------+
| commonscat.py            | Adds {{commonscat}} to Wikipedia categories (or         |
|                          | articles), if other language Wikipedia already has such |
|                          | a template.                                             |
+--------------------------+---------------------------------------------------------+
| commons_information.py   | Insert a language template into the description field.  |
+--------------------------+---------------------------------------------------------+
| coordinate_import.py     | Coordinate importing script.                            |
+--------------------------+---------------------------------------------------------+
| cosmetic_changes.py      | Can do slight modifications to a wiki page source code  |
|                          | such that the code looks cleaner.                       |
+--------------------------+---------------------------------------------------------+
| data_ingestion.py        | A generic bot to do batch uploading to Commons.         |
+--------------------------+---------------------------------------------------------+
| delete.py                | This script can be used to delete pages en masse.       |
+--------------------------+---------------------------------------------------------+
| delinker.py              | Unlink file references of deleted images.               |
+--------------------------+---------------------------------------------------------+
| djvutext.py              | Extracts OCR text from djvu files and uploads onto      |
|                          | pages in the "Page" namespace on Wikisource.            |
+--------------------------+---------------------------------------------------------+
| download_dump.py         | Downloads dumps from dumps.wikimedia.org                |
+--------------------------+---------------------------------------------------------+
| fixing_redirects.py      | Correct all redirect links of processed pages.          |
+--------------------------+---------------------------------------------------------+
| harvest_template.py      | Template harvesting script.                             |
+--------------------------+---------------------------------------------------------+
| illustrate_wikidata.py   | Bot to add images to Wikidata items.                    |
+--------------------------+---------------------------------------------------------+
| image.py                 | Script to replace transclusions of files.               |
+--------------------------+---------------------------------------------------------+
| imagetransfer.py         | Given a wiki page, check the interwiki links for        |
|                          | images, and let the user choose among them for          |
|                          | images to upload.                                       |
+--------------------------+---------------------------------------------------------+
| interwiki.py             | A robot to check interwiki links on all pages (or       |
|                          | a range of pages) of a wiki.                            |
+--------------------------+---------------------------------------------------------+
| interwikidata.py         | Script to handle interwiki links based on Wikibase.     |
+--------------------------+---------------------------------------------------------+
| listpages.py             | Print a list of pages, defined by a page generator.     |
+--------------------------+---------------------------------------------------------+
| misspelling.py           | Similar to solve_disambiguation.py. It is supposed to   |
|                          | fix links that contain common spelling mistakes.        |
+--------------------------+---------------------------------------------------------+
| movepages.py             | Bot that can move pages to another title.               |
+--------------------------+---------------------------------------------------------+
| newitem.py               | Script creates new items on Wikidata based on criteria. |
+--------------------------+---------------------------------------------------------+
| noreferences.py          | Searches for pages where <references /> is missing      |
|                          | although a <ref> tag is present, and in that case adds  |
|                          | a new references section.                               |
+--------------------------+---------------------------------------------------------+
| nowcommons.py            | This bot can delete images with NowCommons template.    |
+--------------------------+---------------------------------------------------------+
| pagefromfile.py          | This bot takes its input from a file that contains a    |
|                          | number of pages to be put on the wiki.                  |
+--------------------------+---------------------------------------------------------+
| parser_function_count.py | Find expensive templates that are subject to be         |
|                          | converted to Lua.                                       |
+--------------------------+---------------------------------------------------------+
| patrol.py                | Obtains a list pages and marks the edits as patrolled   |
|                          | based on a whitelist.                                   |
+--------------------------+---------------------------------------------------------+
| protect.py               | Protect and unprotect pages en masse.                   |
+--------------------------+---------------------------------------------------------+
| redirect.py              | Fix double redirects and broken redirects. Note:        |
|                          | solve_disambiguation also has functions which treat     |
|                          | redirects.                                              |
+--------------------------+---------------------------------------------------------+
| reflinks.py              | Search for references which are only made of a link     |
|                          | without title and fetch the html title from the link to |
|                          | use it as the title of the wiki link in the reference.  |
+--------------------------+---------------------------------------------------------+
| replace.py               | Search articles for a text and replace it by another    |
|                          | text. Both text are set in two configurable             |
|                          | text files. The bot can either work on a set of given   |
|                          | pages or crawl an SQL dump.                             |
+--------------------------+---------------------------------------------------------+
| replicate_wiki.py        | Replicates pages in wiki to a second wiki within family |
+--------------------------+---------------------------------------------------------+
| revertbot.py             | Script that can be used for reverting certain edits.    |
+--------------------------+---------------------------------------------------------+
| solve_disambiguation.py  | Interactive robot doing disambiguation.                 |
+--------------------------+---------------------------------------------------------+
| speedy_delete.py         | Help sysops to quickly check and/or delete pages listed |
|                          | for speedy deletion.                                    |
+--------------------------+---------------------------------------------------------+
| template.py              | Change one template (that is {{...}}) into another.     |
+--------------------------+---------------------------------------------------------+
| templatecount.py         | Display the list of pages transcluding a given list     |
|                          | of templates.                                           |
+--------------------------+---------------------------------------------------------+
| touch.py                 | Bot goes over all pages of the home wiki, and edits     |
|                          | them without changes.                                   |
+--------------------------+---------------------------------------------------------+
| transferbot.py           | Transfers pages from a source wiki to a target wiki.    |
+--------------------------+---------------------------------------------------------+
| transwikiimport.py       | Transfers pages from a source wiki to a target wiki     |
|                          | including edit history using :api:`Import`.             |
+--------------------------+---------------------------------------------------------+
| unusedfiles.py           | Bot appends some text to all unused images and other    |
|                          | text to the respective uploaders.                       |
+--------------------------+---------------------------------------------------------+
| unlink.py                | This bot unlinks a page on every page that links to it. |
+--------------------------+---------------------------------------------------------+
| upload.py                | Upload an image to a wiki.                              |
+--------------------------+---------------------------------------------------------+
| watchlists.py            | Allows access to the account's watchlist.               |
+--------------------------+---------------------------------------------------------+
| weblinkchecker.py        | Check if external links are still working.              |
+--------------------------+---------------------------------------------------------+
| welcome.py               | Script to welcome new users.                            |
+--------------------------+---------------------------------------------------------+

Maintenance
===========

+------------------------+---------------------------------------------------------+
| maintenance            | Framework helper scripts                                |
+========================+=========================================================+
| addwikis.py            | Script to add wikis to a family file.                   |
+------------------------+---------------------------------------------------------+
| cache.py               | Script for showing and deleting API cache.              |
+------------------------+---------------------------------------------------------+
| colors.py              | Utility to show pywikibot colors.                       |
+------------------------+---------------------------------------------------------+
| make_i18n_dict.py      | Generate an i18n file from a given script.              |
+------------------------+---------------------------------------------------------+
| unidata.py             | Updates _first_upper_exception_dict in tools.unidata    |
+------------------------+---------------------------------------------------------+


**External packages could be required with Pywikibot:**

The pwb.py wrapper scripts informs about the requirement and how to install.

More precise information, and a list of the options that are available for
the various programs, can be retrieved by running the bot with the -help
parameter, e.g.::

    python pwb.py interwiki -help

** Outdated and deleted scripts can be recovered.**
Refer `Outdated core scripts` and `Outdated compat scripts` in our documentation:
https://doc.wikimedia.org/pywikibot/master/scripts/index.html#script-descriptions