pywikibot 4.1.0

Python MediaWiki Bot Framework

Pywikibot

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

---

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

• APISite.loadpageinfo does not discard changes to page content when information was not loaded (T260472)

• tools.UnicodeType and tools.signature are deprecated

• BaseBot.stop() method is deprecated in favour of BaseBot.generator.close()

• Escape bot password correctly (T259488)

• Bugfixes and improvements

• Localisation updates

Future release notes

• 4.1.0: Deprecated editor.command will be removed

• 4.1.0: tools.open_compressed, tools.UnicodeType and tools.signature will be removed

• 4.1.0: comms.PywikibotCookieJar and comms.mode_check_decorator will be removed

• 4.0.0: Deprecated tools.UnicodeMixin and tools.IteratorNextMixin will be removed

• 4.0.0: Site.Family() function will be removed in favour of Family.load() method

• 4.0.0: Site.getExpandedString method will be removed in favour of expand_text

• 4.0.0: Unused parameters of page methods like forceReload, insite, throttle, step will be removed

• 4.0.0: site/family methods code2encodings and code2encoding will be removed in favour of encoding/endcodings methods

• 4.0.0: Methods deprecated for 6 years or longer will be removed

• 3.0.20200508: Page.getVersionHistory and Page.fullVersionHistory() methods will be removed (T136513, T151110)

• 3.0.20200306: Support of MediaWiki releases below 1.19 will be dropped (T245350)

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.