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
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
Avoid conflicts between site and possible site keyword in api.Request.create_simple() (T262926)
Remove wrong param of rvision() call in Page.latest_revision_id
Do not raise Exception in Page.get_best_claim() but follow redirect (T265839)
xml-support of wikistats will be dropped
Remove deprecated mime_params in api.Request()
cleanup interwiki_graph.py and replace deprecated originPage by origin in Subjects
Upload a file that ends with the ‘r’ byte (T132676)
Fix incorrect server time (T266084)
L10N-Updates
Support Namespace packages in version.py (T265946)
Server414Error was added to pywikibot (T266000)
Deprecated editor.command() method was removed
comms.PywikibotCookieJar and comms.mode_check_decorator were deleted
Remove deprecated tools classes Stringtypes and UnicodeType
Remove deprecated tools function open_compressed and signature and UnicodeType class
Fix http_tests.LiveFakeUserAgentTestCase (T265842)
HttpRequest properties were renamed to request.Response identifiers (T265206)
Future release notes
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: edit, move, create, upload, unprotect and prompt parameters of Page.protect() will be removed (T227610)
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
4.3.0: Unused UserBlocked exception will be removed
4.3.0: Deprecated Page.contributingUsers() 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.
