Skip to content

Introduction

Python 3.9+ MediaWiki 1.35+ License: GPL v3

pwiki is a Python library which makes interacting with the MediaWiki API simple and easy. It can be used with sites such as Wikipedia, or virtually any other website that runs on MediaWiki.

Installation

pip install pwiki

Overview

I created pwiki with the goal of being simple and powerful, all while being mindful of DX (developer experience). This means that every interaction with the API is simple, easy, and usually just one line of code.

pwiki is split into four main modules:

  1. wiki - The main API and entry point. This module ecompasses most of the functionality for reading from/writing to MediaWiki.
  2. mquery - The batch query API. This module makes it easy to efficiently query against many titles/articles on the MediaWiki instance in fewer round-trips.
  3. gquery - A batch query API that uses python generators to efficiently query for results. This is useful for sampling large quantities of data from MediaWiki in a piecemeal fashion.
  4. wparser - Contains methods for parsing wikitext into higher level object-based models that are easy to work with.