mwklient

MediaWiki API client


Keywords
mediawiki, wikipedia
License
MIT
Install
pip install mwklient==0.1.0

Documentation

mwklient

Build Status License: MIT

Test Coverage Latest Version Python Version Doc Status

mwklient (forked from mwclient v0.9.3) is a lightweight Python client library to the MediaWiki API which provides access to most API functionality. It works with Python 3.5+ and supports MediaWiki API 1.16+, for functions not available in the current MediaWiki, a MediaWikiVersionError is raised.

mwklient vs mwclient

The original project mwclient is still active and supports Python 2.7 too. mwklient is forked from the version 0.9.3 of mwclient and wraps some more api_calls (see next section). Moreover, it will support default error handlers for the most common calls (more details in next commits). Finally, it has a MIT license as well as the original mwclient.

List of new methods

  • page.undo(), revert a given edit page

Installation

The current stable version 0.1.0 is available through PyPI:

pip install mwklient

Documentation

Up-to-date documentation is hosted at Read the Docs. It includes a user guide to get started using mwklient, a reference guide, implementation and development notes.

Contributing

Patches and PR are welcome! Consider also contributing to the original repo. The current development version can be easily installed from GitHub, simply cloning the repo:

git clone https://github.com/lrusso96/mwklient.git

In order to test your edits, build an editable version with the command:

pip install -e .

Finally, if you want to run tests, do

python setup.py test