Pywikibot documentation

Welcome! This is the documentation for Pywikibot 9.6.1.

Pywikibot is a Python library and collection of tools that automate work on MediaWiki sites. Originally designed for Wikipedia, it is now used throughout the Wikimedia Foundation’s projects and on many other MediaWiki wikis.

The project started in 2003 and is currently on core version 9.6.1. It features full API usage and is up-to-date with new MediaWiki features and a Pythonic package layout. But it also works with older installations of MediaWiki 1.27 or higher. For older MediaWiki versions you have to use older Pywikibot releases; refer Compatibility.

Pywikibot supports Microsoft Windows, macOS and Linux when used with a compatible version of Python. It should also work on any other operating system that has a compatible version of Python installed. To check whether you have Python installed and to find its version, just type python at the CMD or shell prompt.

Python 3.7 or higher is currently required to run the bot but Python 3.8 or higher is recommended. Python 3.7 support will be dropped with Pywikibot 10 soon.

Pywikibot and this documentation are licensed under the MIT License; manual pages on mediawiki.org are licensed under the CC-BY-SA 3.0 license.

See also

Pywikibot Manual on https://www.mediawiki.org, which includes additional resources, such as:

• Pywikibot Cookbook

• Pywikibot Workshop Materials

Framework modules overview

Contents

User guide

• Introduction
• Framework utility scripts
• Scripts package
• Global options
• Frequently asked questions
• Getting help

Bot developer guide

• Using pywikibot as library
• Recipes
• API reference
• MediaWiki API cross reference
• Provide your own scripts

Pywikibot contributor guide

• Framework utility scripts reference
• Scripts reference
• Installer scripts
• Tests reference

About

• Change log
• Licenses
• Credits
• Glossary