https://github.com/mwclient/mwclient

Python client library to interface with the MediaWiki API
https://github.com/mwclient/mwclient

mediawiki mediawiki-api python-library wikipedia

Last synced: 3 days ago
JSON representation

Python client library to interface with the MediaWiki API

• Host: GitHub
• URL: https://github.com/mwclient/mwclient
• Owner: mwclient
• License: mit
• Created: 2012-11-26T17:57:38.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-10-25T12:39:50.000Z (3 months ago)
• Last Synced: 2024-10-29T15:24:40.917Z (3 months ago)
• Topics: mediawiki, mediawiki-api, python-library, wikipedia
• Language: Python
• Homepage: https://pypi.org/project/mwclient/
• Size: 939 KB
• Stars: 318
• Watchers: 18
• Forks: 91
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


    

    
mwclient



[![Build status][build-status-img]](https://github.com/mwclient/mwclient)

[![Test coverage][test-coverage-img]](https://coveralls.io/r/mwclient/mwclient)

[![Latest version][latest-version-img]](https://pypi.python.org/pypi/mwclient)

[![MIT license][mit-license-img]](http://opensource.org/licenses/MIT)

[![Documentation status][documentation-status-img]](http://mwclient.readthedocs.io/en/latest/)

[![Issue statistics][issue-statistics-img]](http://isitmaintained.com/project/mwclient/mwclient)

[![Gitter chat][gitter-chat-img]](https://gitter.im/mwclient/mwclient)

[build-status-img]: https://github.com/mwclient/mwclient/actions/workflows/tox.yml/badge.svg

[test-coverage-img]: https://img.shields.io/coveralls/mwclient/mwclient.svg

[latest-version-img]: https://img.shields.io/pypi/v/mwclient.svg

[mit-license-img]: https://img.shields.io/github/license/mwclient/mwclient.svg

[documentation-status-img]: https://readthedocs.org/projects/mwclient/badge/

[issue-statistics-img]: http://isitmaintained.com/badge/resolution/mwclient/mwclient.svg

[gitter-chat-img]: https://img.shields.io/gitter/room/mwclient/mwclient.svg

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.6 and above,

and supports MediaWiki 1.21 and above.

For functions not available in the current MediaWiki,

a `MediaWikiVersionError` is raised.

The current stable

[version 0.11.0](https://github.com/mwclient/mwclient/archive/v0.11.0.zip)

is [available through PyPI](https://pypi.python.org/pypi/mwclient):

```

$ pip install mwclient

```

The current [development version](https://github.com/mwclient/mwclient)

can be installed from GitHub:

```

$ pip install git+git://github.com/mwclient/mwclient.git

```

Please see the [changelog

document](https://github.com/mwclient/mwclient/blob/master/CHANGELOG.md)

for a list of changes.

mwclient was originally written by Bryan Tong Minh. It was maintained

for many years by Dan Michael O. Heggø, with assistance from Waldir

Pimenta. It is currently maintained by Marc Trölitzsch, Adam Williamson

and Megan Cutrofello. The best way to get in touch with the maintainers

is by filing an issue or a pull request.

## Documentation

Up-to-date documentation is hosted [at Read the Docs](http://mwclient.readthedocs.io/en/latest/).

It includes a user guide to get started using mwclient, a reference guide,

implementation and development notes.

There is also some documentation on the [GitHub wiki](https://github.com/mwclient/mwclient/wiki)

that hasn't been ported yet.

If you want to help, you're welcome!

## License

mwclient is licensed under the MIT license. See the [LICENSE.md](LICENSE.md)

file for details.

## Versioning

This project adheres to [Semantic Versioning](http://semver.org/).

## Contributing

Patches are welcome! See [this page](https://mwclient.readthedocs.io/en/latest/development/)

for information on how to get started with mwclient development.