.. image:: https://img.shields.io/github/languages/top/wikimedia/pywikibot
:alt: Top language
:target: https://www.python.org/downloads/
.. 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 | Delink 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
Raw data
{
"_id": null,
"home_page": null,
"name": "pywikibot-scripts",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": "The Pywikibot team <pywikibot@lists.wikimedia.org>",
"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",
"author": null,
"author_email": "xqt <info@gno.de>",
"download_url": null,
"platform": null,
"description": ".. image:: https://img.shields.io/github/languages/top/wikimedia/pywikibot\r\n :alt: Top language\r\n :target: https://www.python.org/downloads/\r\n.. image:: https://img.shields.io/github/last-commit/wikimedia/pywikibot\r\n :alt: Last commit\r\n :target: https://gerrit.wikimedia.org/r/plugins/gitiles/pywikibot/core/\r\n\r\n###########################################################################\r\n**This is a package to include robots for MediaWiki wikis like Wikipedia.**\r\n###########################################################################\r\n\r\n.. role:: api\r\n\r\n*********************************\r\nSome example robots are included.\r\n*********************************\r\n\r\nThese programs can actually modify the live wiki on the net, and proper\r\nwiki-etiquette should be followed before running it on any wiki.\r\n\r\nTo get started on proper usage of the bot framework, refer to `Manual:Pywikibot <https://www.mediawiki.org/wiki/Manual:Pywikibot>`_.\r\n\r\n***************************\r\nThe contents of the package\r\n***************************\r\n\r\nBots and scripts\r\n================\r\n\r\n+--------------------------+---------------------------------------------------------+\r\n| Bots and Scripts |\r\n+==========================+=========================================================+\r\n| add_text.py | Adds text at the top or end of pages. |\r\n+--------------------------+---------------------------------------------------------+\r\n| archivebot.py | Archives discussion threads. |\r\n+--------------------------+---------------------------------------------------------+\r\n| basic.py | Is a template from which simple bots can be made. |\r\n+--------------------------+---------------------------------------------------------+\r\n| blockpagechecker.py | Deletes any protection templates that are on pages |\r\n| | which aren't actually protected. |\r\n+--------------------------+---------------------------------------------------------+\r\n| category.py | Add a category link to all pages mentioned on a page, |\r\n| | change or remove category tags. |\r\n+--------------------------+---------------------------------------------------------+\r\n| category_graph.py | Visualizes category hierarchy |\r\n+--------------------------+---------------------------------------------------------+\r\n| category_redirect.py | Maintain category redirects and replace links to |\r\n| | redirected categories. |\r\n+--------------------------+---------------------------------------------------------+\r\n| change_pagelang.py | Changes the content language of pages. |\r\n+--------------------------+---------------------------------------------------------+\r\n| checkimages.py | Check recently uploaded files. Checks if a file |\r\n| | description is present and if there are other problems |\r\n| | in the image's description. |\r\n+--------------------------+---------------------------------------------------------+\r\n| claimit.py | Adds claims to Wikidata items based on categories. |\r\n+--------------------------+---------------------------------------------------------+\r\n| clean_sandbox.py | This bot resets a sandbox with predefined text. |\r\n+--------------------------+---------------------------------------------------------+\r\n| commonscat.py | Adds {{commonscat}} to Wikipedia categories (or |\r\n| | articles), if other language Wikipedia already has such |\r\n| | a template. |\r\n+--------------------------+---------------------------------------------------------+\r\n| commons_information.py | Insert a language template into the description field. |\r\n+--------------------------+---------------------------------------------------------+\r\n| coordinate_import.py | Coordinate importing script. |\r\n+--------------------------+---------------------------------------------------------+\r\n| cosmetic_changes.py | Can do slight modifications to a wiki page source code |\r\n| | such that the code looks cleaner. |\r\n+--------------------------+---------------------------------------------------------+\r\n| data_ingestion.py | A generic bot to do batch uploading to Commons. |\r\n+--------------------------+---------------------------------------------------------+\r\n| delete.py | This script can be used to delete pages en masse. |\r\n+--------------------------+---------------------------------------------------------+\r\n| delinker.py | Delink file references of deleted images. |\r\n+--------------------------+---------------------------------------------------------+\r\n| djvutext.py | Extracts OCR text from djvu files and uploads onto |\r\n| | pages in the \"Page\" namespace on Wikisource. |\r\n+--------------------------+---------------------------------------------------------+\r\n| download_dump.py | Downloads dumps from dumps.wikimedia.org |\r\n+--------------------------+---------------------------------------------------------+\r\n| fixing_redirects.py | Correct all redirect links of processed pages. |\r\n+--------------------------+---------------------------------------------------------+\r\n| harvest_template.py | Template harvesting script. |\r\n+--------------------------+---------------------------------------------------------+\r\n| illustrate_wikidata.py | Bot to add images to Wikidata items. |\r\n+--------------------------+---------------------------------------------------------+\r\n| image.py | Script to replace transclusions of files. |\r\n+--------------------------+---------------------------------------------------------+\r\n| imagetransfer.py | Given a wiki page, check the interwiki links for |\r\n| | images, and let the user choose among them for |\r\n| | images to upload. |\r\n+--------------------------+---------------------------------------------------------+\r\n| interwiki.py | A robot to check interwiki links on all pages (or |\r\n| | a range of pages) of a wiki. |\r\n+--------------------------+---------------------------------------------------------+\r\n| interwikidata.py | Script to handle interwiki links based on Wikibase. |\r\n+--------------------------+---------------------------------------------------------+\r\n| listpages.py | Print a list of pages, defined by a page generator. |\r\n+--------------------------+---------------------------------------------------------+\r\n| misspelling.py | Similar to solve_disambiguation.py. It is supposed to |\r\n| | fix links that contain common spelling mistakes. |\r\n+--------------------------+---------------------------------------------------------+\r\n| movepages.py | Bot that can move pages to another title. |\r\n+--------------------------+---------------------------------------------------------+\r\n| newitem.py | Script creates new items on Wikidata based on criteria. |\r\n+--------------------------+---------------------------------------------------------+\r\n| noreferences.py | Searches for pages where <references /> is missing |\r\n| | although a <ref> tag is present, and in that case adds |\r\n| | a new references section. |\r\n+--------------------------+---------------------------------------------------------+\r\n| nowcommons.py | This bot can delete images with NowCommons template. |\r\n+--------------------------+---------------------------------------------------------+\r\n| pagefromfile.py | This bot takes its input from a file that contains a |\r\n| | number of pages to be put on the wiki. |\r\n+--------------------------+---------------------------------------------------------+\r\n| parser_function_count.py | Find expensive templates that are subject to be |\r\n| | converted to Lua. |\r\n+--------------------------+---------------------------------------------------------+\r\n| patrol.py | Obtains a list pages and marks the edits as patrolled |\r\n| | based on a whitelist. |\r\n+--------------------------+---------------------------------------------------------+\r\n| protect.py | Protect and unprotect pages en masse. |\r\n+--------------------------+---------------------------------------------------------+\r\n| redirect.py | Fix double redirects and broken redirects. Note: |\r\n| | solve_disambiguation also has functions which treat |\r\n| | redirects. |\r\n+--------------------------+---------------------------------------------------------+\r\n| reflinks.py | Search for references which are only made of a link |\r\n| | without title and fetch the html title from the link to |\r\n| | use it as the title of the wiki link in the reference. |\r\n+--------------------------+---------------------------------------------------------+\r\n| replace.py | Search articles for a text and replace it by another |\r\n| | text. Both text are set in two configurable |\r\n| | text files. The bot can either work on a set of given |\r\n| | pages or crawl an SQL dump. |\r\n+--------------------------+---------------------------------------------------------+\r\n| replicate_wiki.py | Replicates pages in wiki to a second wiki within family |\r\n+--------------------------+---------------------------------------------------------+\r\n| revertbot.py | Script that can be used for reverting certain edits. |\r\n+--------------------------+---------------------------------------------------------+\r\n| solve_disambiguation.py | Interactive robot doing disambiguation. |\r\n+--------------------------+---------------------------------------------------------+\r\n| speedy_delete.py | Help sysops to quickly check and/or delete pages listed |\r\n| | for speedy deletion. |\r\n+--------------------------+---------------------------------------------------------+\r\n| template.py | Change one template (that is {{...}}) into another. |\r\n+--------------------------+---------------------------------------------------------+\r\n| templatecount.py | Display the list of pages transcluding a given list |\r\n| | of templates. |\r\n+--------------------------+---------------------------------------------------------+\r\n| touch.py | Bot goes over all pages of the home wiki, and edits |\r\n| | them without changes. |\r\n+--------------------------+---------------------------------------------------------+\r\n| transferbot.py | Transfers pages from a source wiki to a target wiki. |\r\n+--------------------------+---------------------------------------------------------+\r\n| transwikiimport.py | Transfers pages from a source wiki to a target wiki |\r\n| | including edit history using :api:`Import`. |\r\n+--------------------------+---------------------------------------------------------+\r\n| unusedfiles.py | Bot appends some text to all unused images and other |\r\n| | text to the respective uploaders. |\r\n+--------------------------+---------------------------------------------------------+\r\n| unlink.py | This bot unlinks a page on every page that links to it. |\r\n+--------------------------+---------------------------------------------------------+\r\n| upload.py | Upload an image to a wiki. |\r\n+--------------------------+---------------------------------------------------------+\r\n| watchlists.py | Allows access to the account's watchlist. |\r\n+--------------------------+---------------------------------------------------------+\r\n| weblinkchecker.py | Check if external links are still working. |\r\n+--------------------------+---------------------------------------------------------+\r\n| welcome.py | Script to welcome new users. |\r\n+--------------------------+---------------------------------------------------------+\r\n\r\nMaintenance\r\n===========\r\n\r\n+------------------------+---------------------------------------------------------+\r\n| maintenance | Framework helper scripts |\r\n+========================+=========================================================+\r\n| addwikis.py | Script to add wikis to a family file. |\r\n+------------------------+---------------------------------------------------------+\r\n| cache.py | Script for showing and deleting API cache. |\r\n+------------------------+---------------------------------------------------------+\r\n| colors.py | Utility to show pywikibot colors. |\r\n+------------------------+---------------------------------------------------------+\r\n| make_i18n_dict.py | Generate an i18n file from a given script. |\r\n+------------------------+---------------------------------------------------------+\r\n| unidata.py | Updates _first_upper_exception_dict in tools.unidata |\r\n+------------------------+---------------------------------------------------------+\r\n\r\n\r\n**External packages could be required with Pywikibot:**\r\n\r\nThe pwb.py wrapper scripts informs about the requirement and how to install.\r\n\r\nMore precise information, and a list of the options that are available for\r\nthe various programs, can be retrieved by running the bot with the -help\r\nparameter, e.g.::\r\n\r\n python pwb.py interwiki -help\r\n\r\n** Outdated and deleted scripts can be recovered.**\r\nRefer `Outdated core scripts` and `Outdated compat scripts` in our documentation:\r\nhttps://doc.wikimedia.org/pywikibot/master/scripts/index.html#script-descriptions\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Pywikibot Scripts Collection",
"version": "9.4.1",
"project_urls": {
"Changelog": "https://doc.wikimedia.org/pywikibot/master/changelog.html",
"Documentation": "https://doc.wikimedia.org/pywikibot/stable/",
"Download": "https://www.pywikibot.org",
"GitHub Mirror": "https://github.com/wikimedia/pywikibot",
"Homepage": "https://www.mediawiki.org/wiki/Manual:Pywikibot",
"Repository": "https://gerrit.wikimedia.org/r/plugins/gitiles/pywikibot/core/",
"Tracker": "https://phabricator.wikimedia.org/tag/pywikibot/"
},
"split_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"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dcf8394b0f4bdff18e527efe9a53915814e1a871545242bb01141649ca7efaa8",
"md5": "785da8ee5aae0b36ece99da3a4d92b8e",
"sha256": "e4437d8497509718309020fe293f04e000904191fc3b1c696ed059e1d56715d7"
},
"downloads": -1,
"filename": "pywikibot_scripts-9.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "785da8ee5aae0b36ece99da3a4d92b8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0",
"size": 2165820,
"upload_time": "2024-10-12T11:47:55",
"upload_time_iso_8601": "2024-10-12T11:47:55.831248Z",
"url": "https://files.pythonhosted.org/packages/dc/f8/394b0f4bdff18e527efe9a53915814e1a871545242bb01141649ca7efaa8/pywikibot_scripts-9.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 11:47:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wikimedia",
"github_project": "pywikibot",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "pywikibot-scripts"
}
JSON
