index.rst

mwclient: lightweight MediaWiki client

Mwclient is a :ref:`MIT licensed <license>` client library to the MediaWiki API that should work well with both Wikimedia wikis and other wikis running MediaWiki 1.16 or above. It works with Python 2.7 and 3.3+.

Installation

Installing Mwclient is simple with pip, just run this in your terminal:

pip install mwclient

Quickstart

>>> user_agent = 'MyCoolTool/0.2 (xyz@example.org)'
>>> site = mwclient.Site('en.wikipedia.org', clients_useragent=user_agent)
>>> page = site.pages['Leipäjuusto']
>>> page.text()
'{{Unreferenced|date=September 2009}}\n[[Image:Leip\xe4juusto cheese with cloudberry jam.jpg|thumb|Leip\xe4juusto with [[cloudberry]] jam]]\n\'\'\'Leip\xe4juusto\'\'\' (bread cheese) or \'\'juustoleip\xe4\'\', which is also known in English as \'\'\'Finnish squeaky cheese\'\'\', is a fresh [[cheese]] traditionally made from cow\'s [[beestings]], rich milk from a cow that has recently calved.'
>>> [x for x in page.categories()]
[<Category object 'Category:Finnish cheeses' for <Site object '('https', 'en.wikipedia.org')/w/'>>,
 <Category object 'Category:Articles lacking sources from September 2009' for <Site object '('https', 'en.wikipedia.org')/w/'>>,
 <Category object 'Category:Cow's-milk cheeses' for <Site object '('https', 'en.wikipedia.org')/w/'>>,
 <Category object 'Category:All articles lacking sources' for <Site object '('https', 'en.wikipedia.org')/w/'>>]

User guide

This guide is intended as an introductory overview, and explains how to make use of the most important features of mwclient.

Reference guide

If you are looking for information on a specific function, class or method, this part of the documentation is for you. It's autogenerated from the source code.

Development

Looking for information on contributing to mwclient development?

MIT License

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`