Metadata-Version: 2.1
Name: mwklient
Version: 0.0.4
Summary: MediaWiki API client
Home-page: https://github.com/lrusso96/mwklient
Author: Luigi Russo
Author-email: russo.1699981@studenti.unroma1.it
License: MIT
Keywords: mediawiki wikipedia
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Description-Content-Type: text/markdown
Requires-Dist: requests-oauthlib
Requires-Dist: six

# mwklient
[![Build Status](https://travis-ci.com/lrusso96/mwklient.svg?token=uoNxtXYBDHpqERGMiZA8&branch=master)](https://travis-ci.com/lrusso96/mwklient)
![License: MIT](https://img.shields.io/github/license/lrusso96/mwklient.svg?color=blue)

![Test Coverage](https://img.shields.io/coveralls/github/lrusso96/mwklient.svg)
![Latest Version](https://img.shields.io/pypi/v/mwklient.svg)
![Python Version](https://img.shields.io/pypi/pyversions/mwklient.svg)
[![Doc Status](https://readthedocs.org/projects/mwklient/badge/?version=latest)](https://mwklient.readthedocs.io/en/latest/?badge=latest)


mwklient (forked from [mwclient v0.9.3](https://github.com/mwclient/mwclient)) is a lightweight Python client library to the [MediaWiki API](https://mediawiki.org/wiki/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 and 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.0.4](https://github.com/lrusso96/mwklient/archive/v0.0.4.zip)
is [available through PyPI](https://pypi.python.org/pypi/mwklient):

```
$ pip install mwklient
```

## Documentation
Up-to-date documentation is hosted [at Read the Docs](http://mwklient.readthedocs.io/en/latest/).
It includes a user guide to get started using mwclient, a reference guide, implementation and development notes.

## Contributing
Patches and PR are welcome! Consider also contributing to the original repo.
The current [development version](https://github.com/lrusso96/mwklient) can be
easily installed from GitHub, simply cloning the repo:

```
$ pip install git+git://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
```

