wiki-as-base 0.5.5

Use MediaWiki Wiki page content as read-only database

wiki_as_base-py

[MVP] Use MediaWiki Wiki page content as read-only database. Python library implementation. See https://github.com/fititnt/openstreetmap-serverless-functions/tree/main/function/wiki-as-base

Installing

pip install wiki_as_base --upgrade

Usage

Environment variables

Customize for your needs. They're shared between command line and the library.

export WIKI_API='https://wiki.openstreetmap.org/w/api.php'
export WIKI_NS='osmwiki'

Command line

wiki_as_base --help

## Use remote storage (defined on WIKI_API)
wiki_as_base --titles 'User:EmericusPetro/sandbox/Wiki-as-base'

# The output is JSON-LD. Feel free to further filter the data
wiki_as_base --titles 'User:EmericusPetro/sandbox/Wiki-as-base' | jq .data[1]

## Example of, instead of use WIKI_API, parse Wiki markup directly. Output JSON- LD
cat tests/data/multiple.wiki.txt | wiki_as_base --input-stdin

## Output zip file instead of JSON-LD. --verbose also adds wikiasbase.jsonld to file
cat tests/data/chatbot-por.wiki.txt | wiki_as_base --input-stdin --verbose --output-zip-file tests/temp/chatbot-por.zip

## Use different Wiki with ad-hoc change of the env WIKI_API and WIKI_NS
WIKI_NS=wikidatawiki \
  WIKI_API=https://www.wikidata.org/w/api.php \
  wiki_as_base --titles 'User:EmericusPetro/sandbox/Wiki-as-base'

Click to see more examples for other wikies

# For suggestion of RDF namespaces, see https://dumps.wikimedia.org/backup-index.html
WIKI_NS=specieswiki \
  WIKI_API=https://species.wikimedia.org/w/api.php \
  wiki_as_base --titles 'Paubrasilia_echinata'

# @TODO implement support for MediaWiki version used by wikies like this one
WIKI_NS=smwwiki \
  WIKI_API=https://www.semantic-mediawiki.org/w/api.php \
  wiki_as_base --titles 'Help:Using_SPARQL_and_RDF_stores'

Use of permanent IDs for pages, the WikiMedia pageids

In case the pages are already know upfront (such as automation) then the use of numeric pageid is a better choice.

# "--pageids '295916'" is equivalent to "--titles 'User:EmericusPetro/sandbox/Wiki-as-base'"
wiki_as_base --pageids '295916'

However, if for some reason (such as strictly enforce not just an exact page, but exact version of one or more pages) and getting the latest version is not fully essential, then you can use revids,

# "--revids '2460131'" is an older version of --pageids '295916' and
# "--titles 'User:EmericusPetro/sandbox/Wiki-as-base'"
wiki_as_base --revids '2460131'

Request multiple pages at once, either by pageid or titles

Each MediaWiki API may have different limits for batch requests, however even unauthenticated users often have decent limits (e.g. 50 pages).

Some Wikies may allow very high limits for authenticated accounts (500 pages), however the current version does not implement authenticated requests.

## All the following commands are equivalent for the default WIKI_API

wiki_as_base --input-autodetect '295916|296167'
wiki_as_base --input-autodetect 'User:EmericusPetro/sandbox/Wiki-as-base|User:EmericusPetro/sandbox/Wiki-as-base/data-validation'
wiki_as_base --pageids '295916|296167'
wiki_as_base --titles 'User:EmericusPetro/sandbox/Wiki-as-base|User:EmericusPetro/sandbox/Wiki-as-base/data-validation'

Trivia: since this library and CLI fetch directly from WikiMedia API, and parse Wikitext (not raw HTML), it causes much less server load to request several pages this way than big ones with higher number of template calls 😉.

Advanced filter with jq

When working with the JSON-LD output, you can use jq ("jq is a lightweight and flexible command-line JSON processor."), see more on https://stedolan.github.io/jq/, to filter the data

## Filter tables
wiki_as_base --titles 'User:EmericusPetro/sandbox/Wiki-as-base' | jq '.data[] | select(.["@type"] == "wtxt:Table")'

## Filter Templates
wiki_as_base --titles 'User:EmericusPetro/sandbox/Wiki-as-base' | jq '.data[] | select(.["@type"] == "wtxt:Template")'

Save JSON-LD extracted as files

TODO: explain the implemented feature

Library

• See src/wiki_as_base/cli.py
• See tests/

WARNING: as 2023-12-05 while the command line is less likely to change, the internal calls of this library, names of functions, etc are granted to not be stable.

You can import as a pip package, however set the exact version in special if it is unnatended deployment (e.g. GitHub actions, etc).

# requirements.txt
wiki_as_base==0.5.5

Basic use

import json
from wiki_as_base import WikitextAsData

wtxt = WikitextAsData().set_pages_autodetect("295916|296167")
wtxt_jsonld = wtxt.output_jsonld()

print(f'Total: {len(wtxt_jsonld["data"])}')

for resource in wtxt_jsonld["data"]:
    if resource["@type"] == "wtxt:Table":
        print("table found!")
        print(resource["wtxt:tableData"])

print("Pretty print full JSON output")

print(json.dumps(wtxt.output_jsonld(), ensure_ascii=False, indent=2))

The Specification

The temporary docs page is at https://fititnt.github.io/wiki_as_base-py/

Disclaimer / Trivia

The wiki_as_base allows no-as-complete data extraction from MediaWiki markup text directly by its API or direct input, without need to install server extensions.

Check also the wikimedia/Wikibase, a full server version (which inspired the name).

License

Public domain