pywikibot 6.4.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

Script example

Pywikibot provides bot classes to develop your own script easily:

import pywikibot
from pywikibot import pagegenerators
from pywikibot.bot import ExistingPageBot

class MyBot(ExistingPageBot):

    update_options = {
        'text': 'This is a test text',
        'summary: 'Bot: a bot test edit with Pywikbot.'
    }

    def treat_page(self):
        """Load the given page, do some changes, and save it."""
        text = self.current_page.text
        text += '\n' + self.opt.text
        self.put_current(text, summary=self.opt.summary)

def main():
    """Parse command line arguments and invoke bot."""
    options = {}
    gen_factory = pagegenerators.GeneratorFactory()
    # Option parsing
    local_args = pywikibot.handle_args(args)  # global options
    local_args = gen_factory.handle_args(local_args)  # generators options
    for arg in local_args:
        opt, sep, value = arg.partition(':')
        if opt in ('-summary', '-text'):
            options[opt[1:]] = value
    MyBot(generator=gen_factory.getCombinedGenerator(), **options).run()

if __name == '__main__':
    main()

---

For more documentation on Pywikibot see our docs.

Required external programs

It may require the following programs to function properly:

• 7za: To extract 7z files

Roadmap

Current release changes

• Add support for dagwiki, shiwiki and banwikisource

• Fix and clean up DataSite.get_property_by_name

• Update handling of abusefilter-{disallow,warning} codes (T285317)

• Fix terminal_interface_base.input_list_choice (T285597)

• Fix ItemPage.fromPage call

• Use *iterables instead of genlist in intersect_generators

• Use a sentinel variable to determine the end of an iterable in roundrobin_generators

• Require setuptools 20.8.1 (T284297)

• Add setter and deleter for summary_parameters of AutomaticTWSummaryBot

• L10N updates

• Add update_options attribute to BaseBot class to update available_options

• Clear put_queue when canceling page save (T284396)

• Add -url option to pagegenerators (T239436)

• Add add_text function to textlib (T284388)

• Require setuptools >= 49.4.0 (T284297)

• Require wikitextparser>=0.47.5

• Allow images to upload locally even they exist in the shared repository (T267535)

• Show a warning if pywikibot.__version__ is behind scripts.__version__ (T282766)

• Handle <ce>/<chem> tags as <math> aliases within textlib.replaceExcept() (T283990)

• Expand simulate query response for wikibase support (T76694)

• Double the wait time if ratelimit exceeded (T270912)

• Deprecated extract_templates_and_params_mwpfh and extract_templates_and_params_regex functions were removed

Deprecations

• 6.4.0: Pywikibot began using semantic versioning, all deprecated code will be removed in Pywikibot version 7.0.0.

• 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: 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

• 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.