mwclient: lightweight MediaWiki client

_images/logo.png

Mwclient is an MIT licensed client library for the MediaWiki API that works well with both Wikimedia wikis and other wikis running MediaWiki 1.21 or above. It is compatible with Python 3.6 and above.

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

This project is licensed under the MIT License. The full text of the license is reproduced below:

## MIT License

Copyright (c) Bryan Tong Minh, Dan Michael O. Heggø and contributors

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Versioning

Mwclient uses Semantic Versioning 2.0.0. Versions are numbered MAJOR.MINOR.PATCH. The version will be incremented based on the following:

  • MAJOR version is incremented when backwards incompatible changes are made.

  • MINOR version is incremented when functionality is added in a backwards compatible manner.

  • PATCH version is incremented when backwards compatible bug fixes are made.

Indices and tables