Skip to main content

Python MediaWiki Bot Framework

Project description

Travis Build Status AppVeyor Build Status Code coverage Maintainability Python Pywikibot release Total downloads Monthly downloads Weekly downloads

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

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

  • Check bot/nobots templates for cosmetic_changes hook (T283989)

  • Remove outdated opt._option which is already dropped (T284005)

  • Use IntEnum with cosmetic_changes CANCEL

  • Remove lru_cahce from botMayEdit method and fix it’s logic (T283957)

  • DataSite.createNewItemFromPage() method was removed in favour of ImagePage.fromPage() (T98663)

  • mwparserfromhell or wikitextparser MediaWiki markup parser is mandatory (T106763)

Deprecations

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

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pywikibot-6.3.0.tar.gz (499.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page