Skip to main content

Python MediaWiki Bot Framework

Project description

GitHub CI Code coverage Python Top language Pywikibot release wheel Total downloads Monthly downloads Last commit pywikibot

Pywikibot

The Pywikibot framework is a Python library that interfaces with the MediaWiki API version 1.31 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
pip install -r requirements.txt
python pwb.py <script_name>

Or to install using PyPI (excluding scripts)

pip install pywikibot
pwb <scriptname>

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 Changes

  • Use Lock object in comms.http.PywikibotCookieJarfor thread-safe saving (T396309)

  • Raise TypeError instead of ValueError in i18n.translateif parameter is not a mapping

  • Recognise wildcard in config.usernameswhen running loginscript (T110411)

  • Search for http and https by default in Site.exturlusage() (T396280)

  • Add login methods overview to loginmodule (T396204)

  • Enable EmailAuth with login.ClientLoginManager(T395703)

  • Move tools.threading.RLockto backportsmodule (T395182)

  • Only show the description passed to specialbots.UploadRobotif it is to be verified (T394895)

  • Add support for Python 3.15 (T395177)

Current Deprecations

  • 10.0.0: ‘millenia’ argument for precision parameter of pywikibot.WbTimeis deprecated; ‘millennium’ must be used instead.

  • 10.0.0: includeredirects parameter of pagegenerators.AllpagesPageGeneratorand pagegenerators.PrefixingPageGeneratoris deprecated and should be replaced by filterredir

  • 9.6.0: BaseSite.languages()will be removed in favour of BaseSite.codes

  • 9.5.0: DataSite.getPropertyType()will be removed in favour of DataSite.get_property_type()

  • 9.3.0: page.BasePage.userNameand page.BasePage.isIpEditare deprecated in favour of user or anon attributes of page.BasePage.latest_revisionproperty

  • 9.2.0: Imports of loggingfunctions from botmodule is deprecated and will be desupported

  • 9.2.0: total argument in -logevents pagegenerators option is deprecated; use -limit instead (T128981)

  • 9.0.0: The content parameter of proofreadpage.IndexPage.page_genis deprecated and will be ignored (T358635)

  • 9.0.0: userinterfaces.transliteration.transliterator was renamed to Transliterator

  • 9.0.0: next parameter of userinterfaces.transliteration.transliterator.transliteratewas renamed to succ

  • 9.0.0: type parameter of site.APISite.protectedpages() was renamed to protect_type

  • 9.0.0: all parameter of site.APISite.namespace()was renamed to all_ns

  • 9.0.0: filter parameter of date.dhwas renamed to filter_func

  • 9.0.0: dict parameter of data.api.OptionSetwas renamed to data

  • 9.0.0: pywikibot.version.get_toolforge_hostname() is deprecated without replacement

  • 9.0.0: allrevisions parameter of xmlreader.XmpDumpis deprecated, use revisions instead (T340804)

  • 9.0.0: iteritems method of data.api.Requestwill be removed in favour of items

  • 9.0.0: SequenceOutputter.output() is deprecated in favour of tools.formatter.SequenceOutputter.out property

Pending removal in Pywikibot 11

  • 8.4.0: modules_only_mode parameter of data.api.ParamInfo, its paraminfo_keys class attribute and its preloaded_modules property will be removed

  • 8.4.0: dropdelay and releasepid attributes of throttle.Throttlewill be removed in favour of expiry class attribute

  • 8.2.0: tools.itertools.itergroupwill be removed in favour of backports.batched

  • 8.2.0: normalize parameter of WbTime.toTimestrand WbTime.toWikibasewill be removed

  • 8.1.0: Dependency of exceptions.NoSiteLinkErrorfrom exceptions.NoPageErrorwill be removed

  • 8.1.0: exceptions.Server414Error is deprecated in favour of exceptions.Client414Error

  • 8.0.0: Timestamp.clone()method is deprecated in favour of Timestamp.replace() method.

  • 8.0.0: family.Family.maximum_GET_lengthmethod is deprecated in favour of config.maximum_GET_length(T325957)

  • 8.0.0: addOnly parameter of textlib.replaceLanguageLinksand textlib.replaceCategoryLinksare deprecated in favour of add_only

  • 8.0.0: textlib.TimeStripperregex attributes ptimeR, ptimeznR, pyearR, pmonthR, pdayR are deprecated in favour of patterns attribute which is a textlib.TimeStripperPatterns.

  • 8.0.0: textlib.TimeStripper``groups`` attribute is deprecated in favour of textlib.TIMEGROUPS

  • 8.0.0: LoginManager.get_login_tokenwas replaced by login.ClientLoginManager.site.tokens['login']

  • 8.0.0: data.api.LoginManager() is deprecated in favour of login.ClientLoginManager

  • 8.0.0: APISite.messages()method is deprecated in favour of userinfo[‘messages’]

  • 8.0.0: Page.editTime()method is deprecated and should be replaced by Page.latest_revision.timestamp

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-10.2.0.tar.gz (616.5 kB view details)

Uploaded Source

Built Distribution

pywikibot-10.2.0-py3-none-any.whl (721.0 kB view details)

Uploaded Python 3

File details

Details for the file pywikibot-10.2.0.tar.gz.

File metadata

  • Download URL: pywikibot-10.2.0.tar.gz
  • Upload date:
  • Size: 616.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for pywikibot-10.2.0.tar.gz
Algorithm Hash digest
SHA256 a705c5d8981c2baac0d58350d95435b2f043b1cf31b775f1dbea345ebf9c3993
MD5 74aaf50deadcc491d9f24783066e9916
BLAKE2b-256 a47b984e5e6e2f4e6c8e00052758bedc5d1586286c6ed92c3f8cb09aae8fb2e1

See more details on using hashes here.

File details

Details for the file pywikibot-10.2.0-py3-none-any.whl.

File metadata

  • Download URL: pywikibot-10.2.0-py3-none-any.whl
  • Upload date:
  • Size: 721.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for pywikibot-10.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67c509f5cd177b34dd3448b01266d6eda1254725ddaab76345edcbfea0590678
MD5 616ba1f33e0119342170017fcacbe833
BLAKE2b-256 889bd26ad5cc517a91afeb1ba134b49d3a7a2940071c9acb0536b8424f26fa30

See more details on using hashes here.

Supported by

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