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
Remove deprecated args for Page.protect() (T227610)
Move BaseSite its own site/_basesite.py file
Improve toJSON() methods in page.__init__.py
_is_wikibase_error_retryable rewritten (T48535, 268645)
Replace FrozenDict with frozenmap
WikiStats table may be sorted by any key
Retrieve month names from mediawiki_messages when required
Move Namespace and NamespacesDict to site/_namespace.py file
Fix TypeError in api.LoginManager (T268445)
Add repr() method to BaseDataDict and ClaimCollection
Define availableOptions as deprecated property
Do not strip all whitespaces from Link.title (T197642)
Introduce a common BaseDataDict as parent for LanguageDict and AliasesDict
Replaced PageNotSaved by PageSaveRelatedError (T267821)
Add -site option as -family -lang shortcut
Enable APISite.exturlusage() with default parameters (T266989)
Update tools._unidata._category_cf from Unicode version 13.0.0
Move TokenWallet to site/_tokenwallet.py file
Fix import of httplib after release of requests 2.25 (T267762)
user keyword parameter can be passed to Site.rollbackpage() (T106646)
Check for {{bots}}/{{nobots}} templates in Page.text setter (T262136, T267770)
Remove deprecated UserBlocked exception and Page.contributingUsers()
Add support for some ‘wbset’ actions in DataSite
Fix UploadRobot site attribute (T267573)
Ignore UnicodeDecodeError on input (T258143)
Replace ‘source’ exception regex with ‘syntaxhighlight’ (T257899)
Fix get_known_families() for wikipedia_family (T267196)
Move _InterwikiMap class to site/_interwikimap.py
instantiate a CosmeticChangesToolkit by passing a page
Create a Site from sitename
pywikibot.Site() parameters “interface” and “url” must be keyworded
Lookup the code parameter in xdict first (T255917)
Remove interwiki_forwarded_from list from family files (T104125)
Rewrite Revision class; each data can be accessed either by key or as an attribute (T102735, T259428)
L10N-Updates
Future release notes
5.1.0: Positional arguments of page.Revision must be replaced by keyword arguments (T259428)
5.0.0: wikistats methods fetch, raw_cached, csv, xml will be removed
5.0.0: PageRelatedError.getPage() will be removes in favour of PageRelatedError.page
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: version.getfileversion() is desupported and will be removed
5.0.0: Methods deprecated for 5 years or longer will be removed
5.0.0: Outdated recentchanges parameter will be removed
5.0.0: site.LoginStatus will be removed in favour of login.LoginStatus
5.0.0: Property.getType() method will be removed
5.0.0: Request.http_params() method will be removed
5.0.0: DataSite.get_item() method will be removed
5.0.0: date.MakeParameter() function 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.
