pywikibot 5.3.0

Python MediaWiki Bot Framework

Pywikibot

The Pywikibot framework is a Python library that interfaces with the MediaWiki API version 1.19 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

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

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

• Allow using pywikibot as site-package without user-config.py (T270474)

• Python 3.10 is supported

• Fix AutoFamily scriptpath() call (T270370)

• Add support for skrwiki, skrwiktionary, eowikivoyage, wawikisource, madwiki (T268414, T268460, T269429, T269434, T269442)

• wikistats methods fetch, raw_cached, csv, xml has been removed

• PageRelatedError.getPage() has been removed in favour of PageRelatedError.page

• DataSite.get_item() method has been removed

• global put_throttle option may be given as float (T269741)

• Property.getType() method has been removed

• Family.server_time() method was removed; it is still available from Site object (T89451)

• All HttpRequest parameters except of charset has been dropped (T265206)

• A lot of methods and properties of HttpRequest are deprecared in favour of requests.Resonse attributes (T265206)

• Method and properties of HttpRequest are delegated to requests.Response object (T265206)

• comms.threadedhttp.HttpRequest.raw was replaced by HttpRequest.content property (T265206)

• Desupported version.getfileversion() has been removed

• site parameter of comms.http.requests() function is mandatory and cannot be omitted

• date.MakeParameter() function has been removed

• api.Request.http_params() method has been removed

• L10N updates

Future release notes

• 5.3.0: api.ParamInfo.modules property will be removed

• 5.3.0: LogEntryFactory.logtypes property will be removed

• 5.3.0: stdout parameter of logging.output()/pywikibot.output() function will be desupported

• 5.1.0: Positional arguments of page.Revision must be replaced by keyword arguments (T259428)

• 5.0.0: HttpRequest result of http.fetch() will be replaced by requests.Response (T265206)

• 5.0.0: OptionHandler.options dict will be removed in favour of OptionHandler.opt

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

• 5.0.0: Outdated Site.recentchanges() parameters will be removed

• 5.0.0: site.LoginStatus will be removed in favour of login.LoginStatus

• 5.0.0: pagegenerators.ReferringPageGenerator is desupported and 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.