pywikibot

Python MediaWiki Bot Framework

License: MIT License (MIT License)

Author: The Pywikibot team

Tags: API, bot, framework, mediawiki, pwb, python, pywikibot, pywikipedia, pywikipediabot, wiki, wikimedia, wikipedia

Requires: Python >=2.7.2, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*

Project description

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/compat Package to provide compatibility with compat scripts

pywikibot/data Module with several layers for data access to wiki

pywikibot/families wiki-specific information and settings

pywikibot/tools Miscellaneous helper functions (not wiki-dependent)

pywikibot/userinterfaces GUI and terminal interface

Directories
pywikibot	Library routines, control files and global settings
pywikibot/comms	Communication layer
pywikibot/compat	Package to provide compatibility with compat scripts
pywikibot/data	Module with several layers for data access to wiki
pywikibot/families	wiki-specific information and settings
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

Release history

Current release

Move main categories to top in cosmetic_changes
shell.py always imports pywikibot as default
New roundrobin_generators in tools
New BaseBot method “skip_page” to adjust page counting
Family class is made a singleton class
New rule ‘startcolon’ was introduced in textlib
BaseBot has new methods setup and teardown
UploadBot got a filename prefix parameter (T170123)
cosmetic_changes is able to remove empty sections (T140570)
Pywikibot is following PEP 396 versioning
pagegenerators AllpagesPageGenerator, CombinedPageGenerator, UnconnectedPageGenerator are deprecated
Some DayPageGenerator parameters has been renamed
unicodedata2, httpbin and Flask dependency was removed (T102461, T108068, T178864, T193383)
new projects where provided
Bugfixes and improvements
Documentation updates
Localisation updates (T194893)
Translation updates

3.0.20180505

Enable makepath and datafilepath not to create the directory
Use API’s retry-after value (T144023)
Provide startprefix parameter for Category.articles() (T74101, T143120)
Page.put_async() is marked as deprecated (T193494)
pagegenerators.RepeatingGenerator is marked as deprecated (T192229)
Deprecate requests-requirements.txt (T193476)
Bugfixes and improvements
new mediawiki projects where provided
Localisation updates

3.0.20180403

Deprecation warning: support for Python 2.7.2 and 2.7.3 will be dropped (T191192)
Dropped support for Python 2.6 (T154771)
Dropped support for Python 3.3 (T184508)
Bugfixes and improvements
Localisation updates