pywikibot 6.2.0

Python MediaWiki Bot Framework

Pywikibot

The Pywikibot framework is a Python library that interfaces with the MediaWiki API version 1.23 or higher.

Also included are various general function scripts that can be adapted for different tasks.

For further information about the library excluding scripts see the full code documentation.

Quick start

pip install requests
git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
cd core
git submodule update --init
python pwb.py script_name

Or to install using PyPI (excluding scripts)

pip install -U setuptools
pip install pywikibot

In addition a MediaWiki markup parser is required. Please install one of them:

pip install mwparserfromhell

or

pip install wikitextparser

Our installation guide has more details for advanced usage.

Basic Usage

If you wish to write your own script it’s very easy to get started:

import pywikibot
site = pywikibot.Site('en', 'wikipedia')  # The site we want to run our bot on
page = pywikibot.Page(site, 'Wikipedia:Sandbox')
page.text = page.text.replace('foo', 'bar')
page.save('Replacing "foo" with "bar"')  # Saves the page

Wikibase Usage

Wikibase is a flexible knowledge base software that drives Wikidata. A sample pywikibot script for getting data from Wikibase:

import pywikibot
site = pywikibot.Site('wikipedia:en')
repo = site.data_repository()  # the Wikibase repository for given site
page = repo.page_from_repository('Q91')  # create a local page for the given item
item = pywikibot.ItemPage(repo, 'Q91')  # a repository item
data = item.get()  # get all item data from repository for this item

---

For more documentation on Pywikibot see our docs.

The contents of the package

Directories
pywikibot	Library routines, control files and global settings
pywikibot/comms	Communication layer
pywikibot/data	Module with several layers for data access to wiki
pywikibot/families	wiki-specific information and settings
pywikibot/page	Module with classes for MediaWiki page content
pywikibot/site	Module with classes for MediaWiki sites
pywikibot/specialbots	Module containing special bots reusable by scripts
pywikibot/tools	Miscellaneous helper functions (not wiki-dependent)
pywikibot/userinterfaces	GUI and terminal interface

Required external programs

It may require the following programs to function properly:

• 7za: To extract 7z files

Roadmap

Current release changes

Improvements and Bugfixes

• Use different logfiles for multiple processes of the same script (T56685)

• throttle.pip will be reused as soon as possbile

• terminal_interface_base.TerminalHandler is subclassed from logging.StreamHandler

• Fix iterating of SizedKeyCollection (T282865)

• An abstract base user interface module was added

• APISite method pagelanglinks() may skip links with empty titles (T223157)

• Fix Page.getDeletedRevision() method which always returned an empty list

• Async chunked uploads are supported (T129216, T133443)

• A new InvalidPageError will be raised if a Page has no version history (T280043)

• L10N updates

• Fix __getattr__ for WikibaseEntity (T281389)

• Handle abusefilter-{disallow,warning} codes (T85656)

Code cleanups

• MultipleSitesBot.site attribute was removed (T283209)

• Deprecated BaseSite.category_namespaces() method was removed

• i18n.twntranslate() function was removed in favour of twtranslate()

• siteinfo must be used as a dictionary ad cannot be called anymore

• APISite.has_transcluded_data() method was removed

• Deprecated LogEntry.title() method was removed

• Deprecated APISite.watchpage() method was removed

• OptionHandler.options dict has been removed in favour of OptionHandler.opt

• The toStdout parameter of ui.output has been dropped

• terminal_interface_base.TerminalFormatter was removed

• Move page functions UnicodeToAsciiHtml, unicode2html, url2unicode to tools.chars with renaming them

• Rename _MultiTemplateMatchBuilder to MultiTemplateMatchBuilder

• User.name() method was removed in favour of User.username property

• BasePage.getLatestEditors() method was removed in favour of contributors() or revisions()

• pagenenerators.handleArg() method was renamed to handle_arg() (T271437)

• CategoryGenerator, FileGenerator, ImageGenerator and ReferringPageGenerator pagegenerator functions were removed

• Family.ignore_certificate_error() method was removed in favour of verify_SSL_certificate (T265205)

• tools.is_IP was renamed to is_ip_address due to PEP8

• config2.py was renamed to config.py

• Exceptions were renamed having a suffix “Error” due to PEP8 (T280227)

Deprecations

• 6.2.0: Bot’s availableOptions will be removed in favour of available_options

• 6.2.0: deprecated tools.is_IP will be removed

• 6.2.0: Usage of pywikibot.config2 is deprecated and will be dropped

• 6.2.0: Exceptions must be imported from exceptions namespace (T280227)

• 6.2.0: Deprecated exception identifiers will be removed (T280227)

• 6.2.0: empty_iterator will be removed in favour of iter()

• 6.1.0: tools.frozenmap will be removed in favour of types.MappingProxyType

• 6.1.0: tools.DotReadableDict will be removed

• 6.1.0: mwparserfromhell or wikitextparser MediaWiki markup parser becomes mandatory (T106763)

• 6.1.0: textlib.unescape() function will be removed in favour of html.unescape()

• 6.0.1: Site.undeletepage() and Site.undelete_file_versions() will be removed in favour of Site.undelete() method

• 6.0.1: Site.deletepage() and Site.deleteoldimage() will be removed in favour of Site.delete() method

• 6.0.1: DataSite.createNewItemFromPage() method will be removed in favour of ImagePage.fromPage() (T98663)

• 5.0.0: Methods deprecated for 5 years or longer will be removed

Release history

See https://github.com/wikimedia/pywikibot/blob/stable/HISTORY.rst

Contributing

Our code is maintained on Wikimedia’s Gerrit installation, learn how to get started.

Code of Conduct

The development of this software is covered by a Code of Conduct.