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
python setup.py install

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(rcnamespace=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.0rc4.tar.gz (19.9 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.0rc4-py2.py3-none-any.whl (23.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for mw-api-client-3.0.0rc4.tar.gz
Algorithm Hash digest
SHA256 c071233a52ac0d025a15b7d607190badd29d28a96073fc5776144c527eb938de
MD5 c5e2a38ab560b3e7d2846961a3e5d686
BLAKE2b-256 3f516159f083a31d22091bd2097dc9074b6f63d18a43947e09671849d7b17788

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mw_api_client-3.0.0rc4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 73e161db1cdb899360d7395790fb92089c9994741dd0ed09ea9e238c8372e389
MD5 0704b7aa61becd8bd525a44502b4a644
BLAKE2b-256 6c413ed114ed9e82d349f3375522ddc1ae4e401fe3158b925362f0a6a7d0600f

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