Python MediaWiki Bot Framework
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/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/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
Fix regression of combining sys.path in pwb.py wrapper (T249427)
Site and Page methods deprecated for 10 years or longer are desupported and may be removed (T106121)
Usage of SkipPageError with BaseBot is desupported and may be removed
Ignore InvalidTitle in textlib.replace_links() (T122091)
Raise ServerError also if connection to PetScan timeouts
pagegenerators.py no longer supports ‘oursql’ or ‘MySQLdb’. It now solely supports PyMySQL (T243154, T89976)
Disfunctional Family.versionnumber() method was removed
Refactor login functionality (T137805, T224712, T248767, T248768, T248945)
Bugfixes and improvements
Localisation updates
3.0.20200326
site.py and page.py files were moved to their own folders and will be split in the future
Refactor data attributes of Wikibase entities (T233406)
Functions dealing with stars list are desupported and may be removed
Use path’s stem of script filename within pwb.py wrapper (T248372)
Disfunctional cgi_interface.py was removed (T248292, T248250, T193978)
Fix logout on MW < 1.24 (T214009)
Fixed TypeError in getFileVersionHistoryTable method (T248266)
Outdated secure connection overrides were removed (T247668)
Check for all modules which are needed by a script within pwb.py wrapper
Check for all modules which are mandatory within pwb.py wrapper script
Enable -help option with similar search of pwb.py (T241217)
compat module has been removed (T183085)
Category.copyTo and Category.copyAndKeep methods have been removed
Site.page_restrictions() does no longer raise NoPage (T214286)
Use site.userinfo getter instead of site._userinfo within api (T243794)
Fix endprefix parameter in Category.articles() (T247201)
Fix search for changed claims when saving entity (T246359)
backports.py has been removed (T244664)
Site.has_api method has been removed (T106121)
Bugfixes and improvements
Localisation updates
3.0.20200306
Fix mul Wikisource aliases (T242537, T241413)
Let Site(‘test’, ‘test) be equal to Site(‘test’, ‘wikipedia’) (T228839)
Support of MediaWiki releases below 1.19 will be dropped (T245350)
Provide mediawiki_messages for foreign language codes
Use mw API IP/anon user detection (T245318)
Correctly choose primary coordinates in BasePage.coordinates() (T244963)
Rewrite APISite.page_can_be_edited (T244604)
compat module is deprecated for 5 years and will be removed in next release (T183085)
ipaddress module is required for Python 2 (T243171)
tools.ip will be dropped in favour of tools.is_IP (T243171)
tools.ip_regexp is deprecatd for 5 years and will be removed in next release
backports.py will be removed in next release (T244664)
stdnum package is required for ISBN scripts and cosmetic_changes (T132919, T144288, T241141)
preload urllib.quote() with Python 2 (T243710, T222623)
Drop isbn_hyphenate package due to outdated data (T243157)
Fix UnboundLocalError in ProofreadPage._ocr_callback (T243644)
Deprecate/remove sysop parameter in several methods and functions
Refactor Wikibase entity namespace handling (T160395)
Site.has_api method will be removed in next release
Category.copyTo and Category.copyAndKeep will be removed in next release
weblib module has been removed (T85001)
botirc module has been removed (T212632)
Bugfixes and improvements
Localisation updates
3.0.20200111
Fix broken get_version() in setup.py (T198374)
Rewrite site.log_page/site.unlock_page implementation
Require requests 2.20.1 (T241934)
Make bot.suggest_help a function
Fix gui settings for Python 3.7.4+ (T241216)
Better api error message handling (T235500)
Ensure that required props exists as Page attribute (T237497)
Refactor data loading for WikibaseEntities (T233406)
replaceCategoryInPlace: Allow LRM and RLM at the end of the old_cat title (T240084)
Support for Python 3.4 will be dropped (T239542)
Derive LoginStatus from IntEnum (T213287, T239533)
enum34 package is mandatory for Python 2.7 (T213287)
call LoginManager with keyword arguments (T237501)
Enable Pywikibot for Python 3.8 (T238637)
Derive BaseLink from tools.UnicodeMixin (T223894)
Make _flush aware of _putthread ongoing tasks (T147178)
Add family file for foundation wiki (T237888)
Fix generate_family_file.py for private wikis (T235768)
Add rank parameter to Claim initializer
Add current directory for similar script search (T217195)
Release BaseSite.lock_page mutex during sleep
Implement deletedrevisions api call (T75370)
assert_valid_iter_params may raise AssertionError instead of pywikibot.Error (T233582)
Upcast getRedirectTarget result and return the appropriate page subclass (T233392)
Add ListGenerator for API:filearchive to site module (T230196)
Deprecate the ability to login with a secondary sysop account (T71283)
Enable global args with pwb.py wrapper script (T216825)
Add a new ConfigParserBot class to set options from the scripts.ini file (T223778)
Check a user’s rights rather than group memberships; ‘sysopnames’ will be deprecated (T229293, T189126, T122705, T119335, T75545)
proofreadpage.py: fix footer detection (T230301)
Add allowusertalk to the User.block() options (T229288)
botirc module will be removed in next release (T212632)
weblib module will be removed in next release (T85001)
Bugfixes and improvements
Localisation updates
3.0.20190722
Increase the throttling delay if maxlag >> retry-after (T210606)
deprecate test_family: Site(‘test’, ‘test’), use wikipedia_family: Site(‘test’, ‘wikipedia’) instead (T228375, T228300)
Add “user_agent_description” option in config.py
APISite.fromDBName works for all known dbnames (T225590, 225723, 226960)
remove the unimplemented “proxy” variable in config.py
Make Family.langs property more robust (T226934)
Remove strategy family
Handle closed_wikis as read-only (T74674)
TokenWallet: login automatically
Add closed_wikis to Family.langs property (T225413)
Redirect ‘mo’ site code to ‘ro’ and remove interwiki_replacement_overrides (T225417, T89451)
Add support for badges on Wikibase item sitelinks (T128202)
Remove login.showCaptchaWindow() method
New parameter supplied in suggest_help function for missing dependencies
Remove NonMWAPISite class
Introduce Claim.copy and prevent adding already saved claims (T220131)
Fix create_short_link method after MediaWiki changes (T223865)
Validate proofreadpage.IndexPage contents before saving it
Refactor Link and introduce BaseLink (T66457)
Count skipped pages in BaseBot class
‘actionthrottledtext’ is a retryable wikibase error (T192912)
Clear tokens on logout(T222508)
Deprecation warning: support for Python 2 will be dropped (T213287)
botirc.IRCBot has been dropped
Avoid using outdated browseragents (T222959)
textlib: avoid infinite execution of regex (T222671)
Add CSRF token in sitelogout() api call (T222508)
Refactor WikibasePage.get and overriding methods and improve documentation
Improve title patterns of WikibasePage extensions
Add support for property creation (T160402)
Bugfixes and improvements
Localisation updates
3.0.20190430
Don’t fail if the number of forms of a plural string is less than required (T99057, T219097)
Implement create_short_link Page method to use Extension:UrlShortener (T220876)
Remove wikia family file (T220921)
Remove deprecated ez_setup.py
Changed requirements for sseclient (T219024)
Set optional parameter namespace to None in site.logpages (T217664)
Add ability to display similar scripts when misspelled (T217195)
Check if QueryGenerator supports namespaces (T198452)
Bugfixes and improvements
Localisation updates
3.0.20190301
Fix version comparison (T164163)
Remove pre MediaWiki 1.14 code
Dropped support for Python 2.7.2 and 2.7.3 (T191192)
Fix header regex beginning with a comment (T209712)
Implement Claim.__eq__ (T76615)
cleanup config2.py
Add missing Wikibase API write actions
Bugfixes and improvements
Localisation updates
3.0.20190204
Support python version 3.7
pagegenerators.py: add -querypage parameter to yield pages provided by any special page (T214234)
Fix comparison of str, bytes and int literal
site.py: add generic self.querypage() to query SpecialPages
echo.Notification has a new event_id property as integer
Bugfixes and improvements
Localisation updates
3.0.20190106
Ensure “modules” parameter of ParamInfo._fetch is a set (T122763)
Support adding new claims with qualifiers and/or references (T112577, T170432)
Support LZMA and XZ compression formats
Update correct-ar Typo corrections in fixes.py (T211492)
Enable MediaWiki timestamp with EventStreams (T212133)
Convert Timestamp.fromtimestampformat() if year, month and day are given only
tools.concat_options is deprecated
Additional ListOption subclasses ShowingListOption, MultipleChoiceList, ShowingMultipleChoiceList
Bugfixes and improvements
Localisation updates
3.0.20181203
Remove compat module references from autogenerated docs (T183085)
site.preloadpages: split pagelist in most max_ids elements (T209111)
Disable empty sections in cosmetic_changes for user namespace
Prevent touch from re-creating pages (T193833)
New Page.title() parameter without_brackets; also used by titletranslate (T200399)
Security: require requests version 2.20.0 or later (T208296)
Check appropriate key in Site.messages (T163661)
Make sure the cookie file is created with the right permissions (T206387)
pydot >= 1.2 is required for interwiki_graph
Move methods for simple claim adding/removing to WikibasePage (T113131)
Enable start timestamp for EventStreams (T205121)
Re-enable notifications (T205184)
Use FutureWarning for warnings intended for end users (T191192)
Provide new -wanted… page generators (T56557, T150222)
api.QueryGenerator: Handle slots during initialization (T200955, T205210)
Bugfixes and improvements
Localisation updates
3.0.20180922
Enable multiple streams for EventStreams (T205114)
Fix Wikibase aliases handling (T194512)
Remove cryptography support from python<=2.7.6 requirements (T203435)
textlib._tag_pattern: Do not mistake self-closing tags with start tag (T203568)
page.Link.langlinkUnsafe: Always set _namespace to a Namespace object (T203491)
Enable Namespace.content for mw < 1.16
Allow terminating the bot generator by BaseBot.stop() method (T198801)
Allow bot parameter in set_redirect_target
Do not show empty error messages (T203462)
Show the exception message in async mode (T203448)
Fix the extended user-config extraction regex (T145371)
Solve UnicodeDecodeError in site.getredirtarget (T126192)
Introduce a new APISite property: mw_version
Improve hash method for BasePage and Link
Avoid applying two uniquifying filters (T199615)
Fix skipping of language links in CosmeticChangesToolkit.removeEmptySections (T202629)
New mediawiki projects were provided
Bugfixes and improvements
Localisation updates
3.0.20180823
Don’t reset Bot._site to None if we have already a site object (T125046)
pywikibot.site.Siteinfo: Fix the bug in cache_time when loading a CachedRequest (T202227)
pagegenerators._handle_recentchanges: Do not request for reversed results (T199199)
Use a key for filter_unique where appropriate (T199615)
pywikibot.tools: Add exceptions for first_upper (T200357)
Fix usages of site.namespaces.NAMESPACE_NAME (T201969)
pywikibot/textlib.py: Fix header regex to allow comments
Use ‘rvslots’ when fetching revisions on MW 1.32+ (T200955)
Drop the ‘2’ from PYWIKIBOT2_DIR, PYWIKIBOT2_DIR_PWB, and PYWIKIBOT2_NO_USER_CONFIG environment variables. The old names are now deprecated. The other PYWIKIBOT2_* variables which were used only for testing purposes have been renamed without deprecation. (T184674)
Introduce a timestamp in deprecated decorator (T106121)
textlib.extract_sections: Remove footer from the last section (T199751)
Don’t let WikidataBot crash on save related errors (T199642)
Allow different projects to have different L10N entries (T198889)
remove color highlights before fill function (T196874)
Fix Portuguese file namespace translation in cc (T57242)
textlib._create_default_regexes: Avoid using inline flags (T195538)
Not everything after a language link is footer (T199539)
code cleanups
New mediawiki projects were provided
Bugfixes and improvements
Localisation updates
3.0.20180710
Enable any LogEntry subclass for each logevent type (T199013)
Deprecated pagegenerators options -<logtype>log aren’t supported any longer (T199013)
Open RotatingFileHandler with utf-8 encoding (T188231)
Fix occasional failure of TestLogentries due to hidden namespace (T197506)
Remove multiple empty sections at once in cosmetic_changes (T196324)
Fix stub template position by putting it above interwiki comment (T57034)
Fix handling of API continuation in PropertyGenerator (T196876)
Use PyMySql as pure-Python MySQL client library instead of oursql, deprecate MySQLdb (T89976, T142021)
Ensure that BaseBot.treat is always processing a Page object (T196562, T196813)
Update global bot settings
New mediawiki projects were provided
Bugfixes and improvements
Localisation updates
3.0.20180603
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 were 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 were 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
3.0.20180304
Bugfixes and improvements
Localisation updates
3.0.20180302
Changed requirements for requests and sseclient
Bugfixes and improvements
Localisation updates
3.0.20180204
Deprecation warning: support for py2.6 and py3.3 will be dropped
Changed requirements for cryprography, Pillow and pyOpenSSL
Bugfixes and improvements
Localisation updates
3.0.20180108
Maintenance script to download Wikimedia database dump
Option to auto-create accounts when logging in
Ship wikimania family file
Drop battlestarwiki family file
Bugfixes and improvements
Localisation updates
3.0.20171212
Introduce userscripts directory
Generator settings inside (user-)fixes.py
BaseUnlinkBot has become part of the framework in specialbots.py
Decommission of rcstream
Script files added to https://doc.wikimedia.org/pywikibot/
Other documentation updates
Bugfixes and improvements
Localisation updates
3.0.20170801
Bugfixes and improvements
Localisation updates
3.0.20170713
Implement server side event client EventStreams
Add thanks log support
new ndashredir.py script to create hyphenated redirects
new followlive.py script to flag new articles
new WbUnknown data type for Wikibase
Deprecate APISite.newfiles()
new pagegenerators filter option -titleregexnot
Inverse of pagegenerators -namespace option
Bugfixes and improvements
Localisation updates
Remove panoramiopicker.py script
Remove anarchopedia family out of the framework
CODE_OF_CONDUCT included
3.0.20170521
Replaced the word ‘async’ with ‘asynchronous’ due to python 3.7
Support for Python 2.6 but higher releases are strictly recommended
Bugfixes and improvements
Localisation updates
3.0.20170403
First major release from master branch
requests package is mandatory
Deprecate previous 2.0 branches
2.0rc5
Last stable 2.0 branch
2.0rc4
Remove dependency on pYsearch
Desupport Python 2.6 for Pywikibot 2.0 release branch
2.0rc3
Bugfixes
Localisation updates
i18n: always follow master branch
2.0rc2
Bugfixes and improvements
Localisation updates
2.0rc1
New scripts patrol.py and piper.py ported from old compat branch
isbn.py now supports wikibase
RecentChanges stream (rcstream) support
Sphinx documentation at https://doc.wikimedia.org/pywikibot/
Bugfixes and improvements
Localisation updates
2.0b3
Bugfixes and improvements
2.0b2
Bugfixes and improvements
2.0b1
First stable release branch
1.0 rv 2007-06-19
BeautifulSoup becomes mandatory
new scripts were added
new family files were supported
some scripts were archived
1.0
Sep 26, 2005
First PyWikipediaBot framework release
scripts and libraries for standardizing content
tools for making minor modifications
script making interwiki links
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.