Tools Interface

This rust crate implements structs to easily interface with several Wikipedia/Wikidata/Wikimedia tools and APIs.

It is available as a Rust crate.

Supported tools

• A List Building Tool
• Completer
• Duplicity
• Grep
• List Building
• Missing Topics
• PagePile (read only)
• Pageviews API
• Persondata Template
• PetScan
• Quarry (retrieve existing results only)
• QuickStatements (create and start batches)
• SparqlRC
• WikiNearby
• XTools pages

If you would like to see other tools supported, add a request to the Issue tracker.

Other functionalities

• search on any WMF wiki
• subset two JSON files with pages
• union two JSON files with pages

Binary

There is a ti binary, working as a command-line interface to the tools_interface library. It allows you to run queries against various Wikimedia tools from shell.

Installation

To just use the binary, follow these steps:

# Install rust, unless it is already installed
# See https://rust-lang.org/tools/install/
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install `ti`
cargo install tools_interface

Usage

Use ti help to get the list of subommands, and ti help <subcommand> to get help on a specific subcommand.

Default output format is JSON, so you can pipe the output to jq for downstream processing. Pages are listed in the .pages array, with each page having a title, a prefixed_title, and a namespace_id. Each page can have additional fields, depending on the tool used. The .site object contains the result site's wiki, language and project.

Example: Run a PetScan query with a known PSID, and override two parameters:

ti petscan --id 28348714 --params "foo=bar" "baz=123"

Example: Run Missing Topics on German Wikipedia for the article "Biologie", without template links:

ti missing_topics --wiki dewiki --article Biologie --no_template_links

To convert the output to a more human-readable format, you can use jq:

# First, pipe your output to a file:
ti SOME_COMMAND > test.json
# Assuming you just want the page titles:
jq -r '.pages[].prefixed_title' < test.json
# Assuming the output has additional `counter` fields:
jq -r '.pages[] | "\(.prefixed_title)\t\(.counter)"' < test.json

# Example
# Using PetScan to get a category tree of all churches in Germany, and their Wikidata items:
ti petscan --id 39413398 | jq -r '.pages[] | "\(.prefixed_title)\t\(.metadata.wikidata)"'