Skip to main content

A set of utilities for extracting and processing MediaWiki data.

Project description

MediaWiki Utilities is an open source (MIT Licensed) library developed by Aaron Halfaker for extracting and processing data from MediaWiki installations, slave databses and xml dumps.

This library requires Python 3 or later.

A typical usage looks like this:

from mw.api import Session
from mw.lib import reverts

# Gather a page's revisions from the API
api_session = Session("https://en.wikipedia.org/w/api.php")
revs = api_session.revisions.query(
        titles={"User:EpochFail"},
        properties={'ids', 'sha1'},
        direction="newer"
)

# Creates a revsion event iterator
rev_events = ((rev['sha1'], rev) for rev in revs)

# Detect and print reverts
for revert in reverts.detect(rev_events):
        print("{0} reverted back to {1}".format(revert.reverting['revid'],
                                                revert.reverted_to['revid']))

For more examples, see scripts inside examples/.

Core modules

api

A set of utilities for interacting with MediaWiki’s web API.

  • Session(…) – Constructs an API session with a MediaWiki installation. Contains convenience methods for accessing prop=revisions, list=usercontribs, meta=siteinfo, and list=recentchanges.

database

A set of utilities for interacting with MediaWiki’s database.

  • DB(…) – Constructs a mysql database connector with convenience methods for accessing revision, archive, page, user, and recentchanges.

types

A set of types for working with MediaWiki data.

  • Timestamp(…) – Constructs a robust datatype for dealing with MediaWikis common timestamp formats

xml_dump

A set of utilities for iteratively processing with MediaWiki’s XML database dumps.

  • Iterator(..) – Constructs an iterator over a standard XML dump. Dumps contain site_info and pages. Pages contain metadata and revisions. Revisions contain metadata and text. This is probably why you are here.

  • map(..) – Applies a function to a set of dump files (Iterators) using the multiprocessing module and aggregates the output.

Libraries

lib.persistence

A set of utilities for tracking the persistence of content between revisions

  • State(…) – Constructs an object that represents the current content persistence state of a page. Reports useful details about content when updated.

lib.reverts

A set of utilities for performing revert detection

  • Detector(…) – Constructs an identity revert detector that can be updated manually over the history of a page.

  • detect(…) – Detects reverts in a sequence of revision events.

lib.sessions

A set of utilities for grouping revisions and other events into sessions

  • Cache(…) – Constructs a cache of recent user actions that can be updated manually in order to detect sessions.

  • cluster(…) – Clusters a sequence of user actions into sessions.

lib.titles

A set of utilities for normalizing and parsing page titles

  • Parser(…) – Constructs a parser with a set of namespaces that can be used to parse and normalize page titles.

  • normalize(…) – Normalizes a page title.

About the author

Aaron Halfaker (aaron.halfaker@gmail.com) – http://halfaker.infohttp://en.wikipedia.org/User:EpochFail

Contributors

None yet. See http://github.com/halfak/mediawiki-utilities

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

mediawiki-utilities-0.2.0.zip (59.3 kB view details)

Uploaded Source

mediawiki-utilities-0.2.0.tar.gz (30.1 kB view details)

Uploaded Source

File details

Details for the file mediawiki-utilities-0.2.0.zip.

File metadata

File hashes

Hashes for mediawiki-utilities-0.2.0.zip
Algorithm Hash digest
SHA256 9e07c14ddb3d01029d63a8c4f328e03bd44f03eb12eaeee33456f487cd8dd0a7
MD5 6b2defd82361059c07eea76da75ddeb6
BLAKE2b-256 d8d58473645b211d0a718d763cb72d4e794e1199020f76e0824edae62ba63c72

See more details on using hashes here.

File details

Details for the file mediawiki-utilities-0.2.0.tar.gz.

File metadata

File hashes

Hashes for mediawiki-utilities-0.2.0.tar.gz
Algorithm Hash digest
SHA256 7a0fe9bfe537a5ff6196701f7d93bb31f087acf55936a3e9a91f4505158ab56e
MD5 884466e13241c09d4de0219cbebcc2b7
BLAKE2b-256 9f77ecdb799c3b5d177152201d690bcfdce733ba4c317ffa52d70873f9982cd6

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