Python MediaWiki Bot Framework
Project description
Pywikibot
The Pywikibot framework is a Python library that interfaces with the MediaWiki API version 1.19 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
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
Re-enable reading user-config.py from site package (T270941)
LoginManager.getCookie() was renamed to login_to_site()
Deprecation warning for MediaWiki < 1.23 (T268979)
Add backports to support some Python 3.9 changes
Desupported shared_image_repository() and nocapitalize() methods were removed (T89451)
pywikibot.cookie_jar was removed in favour of pywikibot.comms.http.cookie_jar
Align http.fetch() params with requests and rename ‘disable_ssl_certificate_validation’ to ‘verify’ (T265206)
Deprecated compat BasePage.getRestrictions() method was removed
Outdated Site.recentchanges() parameters has been dropped
site.LoginStatus has been removed in favour of login.LoginStatus
L10N Updates
Future release notes
5.4.0: Support of MediaWiki < 1.23 will be dropped with release 6.0 (T268979)
5.4.0: LoginManager.getCookie() is deprecated and will be removed
5.4.0: tools.PY2 will be removed (T213287)
5.3.0: api.ParamInfo.modules property will be removed
5.3.0: LogEntryFactory.logtypes property will be removed
5.3.0: stdout parameter of logging.output()/pywikibot.output() function will be desupported
5.1.0: Positional arguments of page.Revision must be replaced by keyword arguments (T259428)
5.0.0: HttpRequest result of http.fetch() will be replaced by requests.Response (T265206)
5.0.0: OptionHandler.options dict will be removed in favour of OptionHandler.opt
5.0.0: Methods deprecated for 5 years or longer will be removed
5.0.0: pagegenerators.ReferringPageGenerator is desupported and 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.
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.
