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.0rc3.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.0rc3-py2.py3-none-any.whl (21.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for mw-api-client-3.0.0rc3.tar.gz
Algorithm Hash digest
SHA256 c54c30416ee98ffa9b55c359305231d20882de1d61bda96aff7bb5049a036303
MD5 08d0044ca26fc7e00c262d7abdc33098
BLAKE2b-256 0b7ce39caab9b5c6e78e4a6ffe1da62cf420f4e333be130061e936b759957f54

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mw_api_client-3.0.0rc3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d35e5475888eb3800f19731f5a7d7f77e434aefaf9e893a457ece6ecc8ce0e99
MD5 fb307ef4f58c8791a4d54f24bb7cbc5d
BLAKE2b-256 915109838a336bba2f96a7600270ed3ae803394679043384b767a970edc5f1a5

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