-
Waldir Pimenta authoredWaldir Pimenta authored
mwclient
mwclient is a lightweight Python client library to the
MediaWiki API
which provides access to most API functionality.
It works with Python 2.7, 3.3 and above,
and supports MediaWiki 1.16 and above.
For functions not available in the current MediaWiki,
a MediaWikiVersionError
is raised.
The current stable version 0.8.7 is available through PyPI:
$ pip install mwclient
The current development version can be installed from GitHub:
$ pip install git+git://github.com/mwclient/mwclient.git
Please see the changelog document for a list of changes.
Getting started
See the user guide to get started using mwclient.
For more information, see the REFERENCE.md file and the documentation on the wiki.
Contributing
mwclient ships with a test suite based on pytest. Only a small part of mwclient is currently tested, but hopefully coverage will improve in the future.
The easiest way to run the tests is:
$ python setup.py test
This will make an in-place build and download test dependencies locally if needed. To make tests run faster, you can use pip to do an "editable" install:
$ pip install pytest pytest-pep8 responses
$ pip install -e .
$ py.test
To run tests with different Python versions in isolated virtualenvs, you can use Tox: