Skip to main content

A simple MediaWiki client.

Project description

A really simple MediaWiki API client.

Can use most MediaWiki API modules.

Requires the requests library.

http://www.mediawiki.org/

Installation

To install the latest stable version:

pip install -U mw-api-client

To install the latest development (likely unstable) version:

git clone https://github.com/Kenny2github/mw-api-client.git
cd mw-api-client
pip install -e .

Example Usage

import mw_api_client as mw

Get a page:

wp = mw.Wiki("https://en.wikipedia.org/w/api.php", "MyCoolBot/0.0.0")

wp.login("kenny2wiki", password)

sandbox = wp.page("User:Kenny2wiki/sandbox")

Edit page:

# Get the page
contents = sandbox.read()

# Change
contents += "\n This is a test!"
summary = "Made a test edit"

# Submit
sandbox.edit(contents, summary)

List pages in category:

for page in wp.category("Redirects").categorymembers():
    print(page.title)

Remove all uses of a template:

stub = wp.template("Stub")

# Pages that transclude stub, main namespace only
target_pages = list(stub.transclusions(namespace=0))

# Sort by title because it's prettier that way
target_pages.sort(key=lambda p: p.title)

for page in target_pages:
    page.replace("{{stub}}", "")

Patrol all recent changes in the Help namespace:

rcs = wp.recentchanges(namespace=12)

for rc in rcs:
    rc.patrol()

Made by Kenny2github, based off of ~blob8108’s Scratch Wiki API client.

MIT Licensed.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mw-api-client-3.0.0rc1.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mw_api_client-3.0.0rc1-py2.py3-none-any.whl (21.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mw-api-client-3.0.0rc1.tar.gz.

File metadata

File hashes

Hashes for mw-api-client-3.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 fef99f7ceaac0a6c1191137290edf861bfc82fd151486db521e836da40ce2222
MD5 ff975cc7ec11e4944e35eba49421556e
BLAKE2b-256 5879ebcda0cc840a5d45c30236efbb27d425a67b027cfaa5009e5cbece53a128

See more details on using hashes here.

File details

Details for the file mw_api_client-3.0.0rc1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mw_api_client-3.0.0rc1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cb3d78981b11510dfe6f8196cfbd06e3340b9caaa0bbc8085ee8c7d308685d40
MD5 c6647d912483c25ebaf60c1eb1c8af85
BLAKE2b-256 db5ca109a5ea29577f9c64594f3992870f77534202199f81929d8f1fbb130baa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page