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.2.2.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

mw_api_client-3.2.2-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mw-api-client-3.2.2.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for mw-api-client-3.2.2.tar.gz
Algorithm Hash digest
SHA256 7375996156d7f4957d11886141add846ab049dfa73a29eacd11a496965cc1270
MD5 520d8da069a94aa325b73f93d0f26fd3
BLAKE2b-256 f507b161d96acd1757d1bd653c04b4879dfc182bf42aaf3dcfdd9a7aee1e6582

See more details on using hashes here.

File details

Details for the file mw_api_client-3.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mw_api_client-3.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 799a7c4426bab827e93910e998fae19534758592171cb615ce182e472953e961
MD5 9b326cb5d3ec5b9297dccc0b5c0d4b4d
BLAKE2b-256 3e0d92586e9f8e481ee35db4bcf624e18c324536ae73e8373effab84e8ebd3bd

See more details on using hashes here.

Supported by

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