mwpy

An async MediaWiki client using trio and asks.


Keywords
asks, mediawiki-api, python, trio
License
GPL-3.0
Install
pip install mwpy==0.3

Documentation

image

image

image

This is a personal pet project. An async Python client for MediaWiki API built on top of asks and trio! Currently this project is abandoned in favour of pymw, a synchronous fork of this project that uses requests.

Installation

mwpy requires Python 3.9+!

pip install mwpy

Notable features

  • Supports setting a custom User-Agent header for each API instance.
  • Handles query continuations.
  • Handles batchcomplete signals for prop queries and yeilds the results as soon as a batch is complete.
  • Configurable maxlag. Waits as the API recommends and then retries.
  • Some convenient methods for accessing common API calls, e.g. for recentchanges, login, and siteinfo.
  • Lightweight. mwpy is a thin wrapper. Method signatures are very similar to the parameters in an actual API URL. You can consult MediaWiki's documentation if in doubt about what a parameter does.