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.0.tar.gz (17.5 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.0-py2.py3-none-any.whl (20.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: mw-api-client-3.0.0.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mw-api-client-3.0.0.tar.gz
Algorithm Hash digest
SHA256 2483285cecf9a4d9300dcd71bd685be73afc7c2dd3c7b9573198ea584d5d0616
MD5 31e02302e0842b2e1ec2789637705f49
BLAKE2b-256 280268af3821abd54388f1c6c32f8ae49ed39991ec33efe37c86c15393c7b803

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mw_api_client-3.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a13f385eec914f0b5c1a720fee0db14124dde7b61f9bb0c6a33f81359dcc78f0
MD5 5adba4ed8ada16fc008cf174d7438f85
BLAKE2b-256 b4a785cc9a1bfc3749e1d6bd47f8e0096a832793d0b201fdb6b90ff4cb283331

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