Skip to main content

Python MediaWiki Bot Framework

Project description

Travis Build Status AppVeyor Build Status Code coverage Maintainability Python Pywikibot release

Pywikibot

The Pywikibot framework is a Python library that interfaces with the MediaWiki API version 1.14 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
python pwb.py script_name

Or to install using PyPI (excluding scripts)

pip install -U setuptools
pip install pywikibot

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

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

  • Unify and extend formats for setting sitelinks (T225863, T251512)

  • Do not return a random i18n.translation() result (T220099)

  • tools.ip_regexp has been removed (T174482)

  • Page.getVersionHistory and Page.fullVersionHistory() methods has been desupported (T136513, T151110)

  • Update wikimediachapter_family (T250802)

  • Raise SpamblacklistError with spamblacklist APIError (T249436)

  • Do not removeUselessSpaces inside source/syntaxhighlight tags (T250469)

  • Restrict Pillow to 6.2.2+ (T249911)

  • Fix PetScan generator language and project (T249704)

  • test_family has been removed (T228375, T228300)

  • Bugfixes and improvements

  • Localisation updates

Future releases

  • Page.getVersionHistory and Page.fullVersionHistory() methods will be removed (T136513, T151110)

  • 3.0.20200405: Site and Page methods deprecated for 10 years or longer will be removed

  • 3.0.20200405: Usage of SkipPageError with BaseBot will be removed

  • 3.0.20200326: Functions dealing with stars list will be removed

  • 3.0.20200306: Support of MediaWiki releases below 1.19 will be dropped (T245350)

  • 3.0.20200306: tools.ip will be dropped in favour of tools.is_IP (T243171)

  • 3.0.20200111: Support for Python 3.4 will be dropped (T239542)

  • 3.0.20190722: Support for Python 2 will be dropped in 4/2020 (T213287)

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

Uploaded Source

File details

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

File metadata

  • Download URL: pywikibot-3.0.20200508.tar.gz
  • Upload date:
  • Size: 516.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0

File hashes

Hashes for pywikibot-3.0.20200508.tar.gz
Algorithm Hash digest
SHA256 c61095a8d56c02ebc73f5c23f7e75248f11e0272d88cbe6b5d258b0438cbb0b6
MD5 58b2399f8d8b2430a2eb0d4bd5830ec8
BLAKE2b-256 423decfce167ec6b29726d043ec324daf29e48b094c37319a7b193bbd9e40610

See more details on using hashes here.

Provenance

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