Skip to main content

Python MediaWiki Bot Framework

Project description

Github CI AppVeyor Build Status Code coverage Maintainability Python Top language Pywikibot release wheel Total downloads Monthly downloads Lines of Code Last commit

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
pwb <scriptname>

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 Pywikibot.'
    }

    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.

Roadmap

Current release 7.7.0

  • TypeError is raised if aliases parameter of WikibasePage.editAliases

    method is not a list (T318034)

  • Raise TypeError in AliasesDict.normalizeData

    if data value is not a list (T318034)

  • tools’ threading classes were moved to tools.threading submodule

  • No longer raise NotimplementedError in APISite.page_from_repository

    (T318033)

  • Ability to set PYWIKIBOT_TEST_... environment variables with pwb wrapper (T139847)

  • OmegaWiki family was removed

  • Provide global -config option to specify the user config file name

  • Run pywikibot.scripts.login script in parallel tasks if -async option is given (T57899)

  • Ability to preload categories was added to APISite.preloadpages

    (T241689)

  • Add WikiBlame support was added to get the five topmost authors

  • Raise KeyError instead of AttributeError if page.FileInfo is used as Mapping

  • i18n and L10N updates

Deprecations

  • 7.7.0: tools.threading classes should no longer imported from tools

  • 7.6.0: tools.itertools datatypes should no longer imported from tools

  • 7.6.0: tools.collections datatypes should no longer imported from tools

  • 7.5.0: textlib.tzoneFixedOffset class will be removed in favour of time.TZoneFixedOffset

  • 7.4.0: FilePage.usingPages() was renamed to using_pages()

  • 7.2.0: tb parameter of exception() function was renamed to exc_info

  • 7.2.0: XMLDumpOldPageGenerator is deprecated in favour of a content parameter of XMLDumpPageGenerator (T306134)

  • 7.2.0: RedirectPageBot and NoRedirectPageBot bot classes are deprecated in favour of use_redirects attribute

  • 7.2.0: tools.formatter.color_format is deprecated and will be removed

  • 7.1.0: Unused get_redirect parameter of Page.getOldVersion() will be removed

  • 7.1.0: APISite._simple_request() will be removed in favour of APISite.simple_request()

  • 7.0.0: User.isBlocked() method is renamed to is_blocked for consistency

  • 7.0.0: Private BaseBot counters _treat_counter, _save_counter, _skip_counter will be removed in favour of collections.Counter counter attribute

  • 7.0.0: A boolean watch parameter in Page.save() is deprecated and will be desupported

  • 7.0.0: baserevid parameter of editSource(), editQualifier(), removeClaims(), removeSources(), remove_qualifiers() DataSite methods will be removed

  • 7.0.0: Values of APISite.allpages() parameter filterredir other than True, False and None are deprecated

  • 6.5.0: OutputOption.output() method will be removed in favour of OutputOption.out property

  • 6.5.0: Infinite rotating file handler with logfilecount of -1 is deprecated

  • 6.4.0: ‘allow_duplicates’ parameter of tools.itertools.intersect_generators as positional argument is deprecated, use keyword argument instead

  • 6.4.0: ‘iterables’ of tools.itertools.intersect_generators given as a list or tuple is deprecated, either use consecutive iterables or use ‘*’ to unpack

  • 6.2.0: outputter of OutputProxyOption without out property is deprecated

  • 6.2.0: ContextOption.output_range() and HighlightContextOption.output_range() are deprecated

  • 6.2.0: Error messages with ‘%’ style is deprecated in favour for str.format() style

  • 6.2.0: page.url2unicode() function is deprecated in favour of tools.chars.url2string()

  • 6.2.0: Throttle.multiplydelay attribute is deprecated

  • 6.2.0: SequenceOutputter.format_list() is deprecated in favour of ‘out’ property

  • 6.0.0: config.register_family_file() is deprecated

Will be removed in Pywikibot 8

  • 7.3.0: Python 3.5 support will be dropped (T301908)

  • 7.1.0: win32_unicode.py will be removed

  • 7.0.0: The i18n identifier ‘cosmetic_changes-append’ will be removed in favour of ‘pywikibot-cosmetic-changes’

  • 7.0.0: pymysql < 0.7.11 will be dropped; require pymysql >= 0.7.11 (T216741)

  • 5.5.0: APISite.redirectRegex() will be removed in favour of APISite.redirect_regex()

  • 4.0.0: Revision.parent_id will be removed in favour of Revision.parentid

  • 4.0.0: Revision.content_model will be removed in favour of Revision.contentmodel

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.

Project details


Release history Release notifications | RSS feed

This version

7.7.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pywikibot-7.7.2.tar.gz (590.9 kB view hashes)

Uploaded source

Built Distribution

pywikibot-7.7.2-py3-none-any.whl (690.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page