.. image:: https://github.com/wikimedia/pywikibot/actions/workflows/pywikibot-ci.yml/badge.svg?branch=master :alt: GitHub CI :target: https://github.com/wikimedia/pywikibot/actions/workflows/pywikibot-ci.yml .. image:: https://codecov.io/gh/wikimedia/pywikibot/branch/master/graph/badge.svg :alt: Code coverage :target: https://app.codecov.io/gh/wikimedia/pywikibot .. image:: https://api.codeclimate.com/v1/badges/de6ca4c66e7c7bee4156/maintainability :alt: Maintainability :target: https://codeclimate.com/github/wikimedia/pywikibot .. image:: https://img.shields.io/pypi/pyversions/pywikibot.svg :alt: Python :target: https://www.python.org/downloads/ .. image:: https://img.shields.io/github/languages/top/wikimedia/pywikibot :alt: Top language :target: https://www.python.org/downloads/ .. image:: https://img.shields.io/pypi/v/pywikibot.svg :alt: Pywikibot release :target: https://pypi.org/project/pywikibot/ .. image:: https://img.shields.io/pypi/wheel/pywikibot :alt: wheel :target: https://pypi.org/project/pywikibot/ .. image:: https://static.pepy.tech/badge/pywikibot :alt: Total downloads :target: https://pepy.tech/project/pywikibot .. image:: https://static.pepy.tech/personalized-badge/pywikibot?period=month&units=international_system&left_color=black&right_color=blue&left_text=monthly :alt: Monthly downloads :target: https://pepy.tech/project/pywikibot .. image:: https://img.shields.io/github/last-commit/wikimedia/pywikibot :alt: Last commit :target: https://gerrit.wikimedia.org/r/plugins/gitiles/pywikibot/core/
Pywikibot
The Pywikibot framework is a Python library that interfaces with the
MediaWiki API <https://www.mediawiki.org/wiki/API:Main_page>_
version 1.31 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 <https://doc.wikimedia.org/pywikibot/stable/>_.
.. code:: text
git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
cd core
git submodule update --init
pip install -r requirements.txt
python pwb.py <script_name>
Or to install using PyPI (excluding scripts)
.. code:: text
pip install pywikibot
pwb <scriptname>
Our installation guide <https://www.mediawiki.org/wiki/Manual:Pywikibot/Installation>_
has more details for advanced usage.
If you wish to write your own script it's very easy to get started:
.. code:: python
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 is a flexible knowledge base software that drives Wikidata. A sample pywikibot script for getting data from Wikibase:
.. code:: python
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
Pywikibot provides bot classes to develop your own script easily:
.. code:: python
import pywikibot
from pywikibot import pagegenerators
from pywikibot.bot import ExistingPageBot
class MyBot(ExistingPageBot):
update_options = {
'text': 'This is a test text',
'summary': 'Bot: a bot test edit with Pywikibot.'
}
def treat_page(self):
"""Load the given page, do some changes, and save it."""
text = self.current_page.text
text += '\n' + self.opt.text
self.put_current(text, summary=self.opt.summary)
def main():
"""Parse command line arguments and invoke bot."""
options = {}
gen_factory = pagegenerators.GeneratorFactory()
# Option parsing
local_args = pywikibot.handle_args(args) # global options
local_args = gen_factory.handle_args(local_args) # generators options
for arg in local_args:
opt, sep, value = arg.partition(':')
if opt in ('-summary', '-text'):
options[opt[1:]] = value
MyBot(generator=gen_factory.getCombinedGenerator(), **options).run()
if __name == '__main__':
main()
For more documentation on Pywikibot see our docs <https://doc.wikimedia.org/pywikibot/>_.
Use WikiHistory instead of XTools to implement Page.authorship() (T392345)
Correct comms.eventstreams.EventStreamskwarg name from last_event_id to latest_event_id (T394570)
Retieve charset from accept-charset header entry in comms.http._decide_encoding(T392345)
Skip CosmeticChangesToolkit.removeEmptySections() if section length is too less (T391776)
Add support for nupwiki (T390713)
i18n updates
No longer follow redirects in bot.open_webbrowser(T390447)
Update closed and removed wikis (T390732)
page parameter was added to site.recentchanges()
googlesearch-python package is required for pagegenerators.GoogleSearchPageGenerator
10.0.0: 'millenia' argument for precision parameter of pywikibot.WbTimeis deprecated; 'millennium' must be used instead.
10.0.0: includeredirects parameter of pagegenerators.AllpagesPageGeneratorand pagegenerators.PrefixingPageGeneratoris deprecated and should be replaced by filterredir
9.6.0: BaseSite.languages()will be removed in favour of BaseSite.codes
9.5.0: DataSite.getPropertyType()will be removed in favour of DataSite.get_property_type()
9.3.0: page.BasePage.userNameand page.BasePage.isIpEditare deprecated in favour of
user or anon attributes of page.BasePage.latest_revisionproperty
9.2.0: Imports of loggingfunctions from botmodule is deprecated and will be desupported
9.2.0: total argument in -logevents pagegenerators option is deprecated;
use -limit instead (T128981)
9.0.0: The content parameter of proofreadpage.IndexPage.page_genis deprecated and will be ignored (T358635)
9.0.0: userinterfaces.transliteration.transliterator was renamed to Transliterator
9.0.0: next parameter of userinterfaces.transliteration.transliterator.transliteratewas renamed to
succ
9.0.0: type parameter of site.APISite.protectedpages()
was renamed to protect_type
9.0.0: all parameter of site.APISite.namespace()was renamed to
all_ns
9.0.0: filter parameter of date.dhwas renamed to filter_func
9.0.0: dict parameter of data.api.OptionSetwas renamed to data
9.0.0: pywikibot.version.get_toolforge_hostname() is deprecated without replacement
9.0.0: allrevisions parameter of xmlreader.XmpDumpis deprecated, use revisions instead
(T340804)
9.0.0: iteritems method of data.api.Requestwill be removed in favour of items
9.0.0: SequenceOutputter.output() is deprecated in favour of tools.formatter.SequenceOutputter.out
property
exceptions.Server414Error is deprecated in favour of exceptions.Client414ErrorTimestamp.replace() method.addOnly parameter of textlib.replaceLanguageLinksand
textlib.replaceCategoryLinksare deprecated in favour of add_onlyptimeR, ptimeznR, pyearR, pmonthR,
pdayR are deprecated in favour of patterns attribute which is a
textlib.TimeStripperPatterns.groups attribute is deprecated in favour of textlib.TIMEGROUPSlogin.ClientLoginManager.site.tokens['login']data.api.LoginManager() is deprecated in favour of login.ClientLoginManagerSee https://github.com/wikimedia/pywikibot/blob/stable/HISTORY.rst
Our code is maintained on Wikimedia's Gerrit installation <https://gerrit.wikimedia.org/>,
learn <https://www.mediawiki.org/wiki/Developer_account> how to get
started.
The development of this software is covered by a
Code of Conduct <https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct>_.
FAQs
Python MediaWiki Bot Framework
We found that pywikibot demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10.12.1 introduces a global virtual store for faster installs and new options for managing dependencies with version catalogs.
Security News
Amaro 1.0 lays the groundwork for stable TypeScript support in Node.js, bringing official .ts loading closer to reality.
Research
A deceptive PyPI package posing as an Instagram growth tool collects user credentials and sends them to third-party bot services.