wikibase-sdk

wikibase-sdk

JS utils functions to query a Wikibase instance and simplify its results

This package was primarily developed as wikidata-sdk but has now being generalized to support any Wikibase instance: wikidata.org among others.

This project received a Wikimedia Project Grant.

         

Summary

• Changelog
• Dependencies
• Install
• Import
• Features
  • Wikibase API
  • Wikibase Query
  • General helpers
• Contributing
• Donate
• See Also
• You may also like
• License

Changelog

See CHANGELOG.md for version info

Dependencies

This module uses JavaScript ES6, which means NodeJS >= v6.4.0 or not too outdated web browsers.

For older version, you can use ES5 bundles.

Install

npm install wikibase-sdk

Import

const wbk = require('wikibase-sdk')({
  instance: 'https://my-wikibase-instan.se',
  sparqlEndpoint: 'https://query.my-wikibase-instan.se/sparql'
})

The wdk object of previous versions of this documentation - from the time this module was bound to wikidata.org only - thus corresponds to the following:

const wdk = require('wikibase-sdk')({
  instance: 'https://www.wikidata.org',
  sparqlEndpoint: 'https://query.wikidata.org/sparql'
})

For convenience, and for the sake of retro-compatibility, that same wdk object can be obtain with:

// After having run `npm install wikidata-sdk`
const wdk = require('wikidata-sdk')

and instance-independant helper functions are directly available from the module root:

const { simplify, parse, isEntityId, isPropertyId, ... } = require('wikibase-sdk')

Features

Wikibase API

A set of functions to make read queries to a Wikibase instance API (see Wikidata API documentation). For write operations, see wikibase-edit.

• Search entities
• Get entities
  • By ids
  • By id and revision
  • By Wikipedia titles
  • By other Wikimedia projects titles
• Simplify entities data
• Get revisions

Wikibase Query

There are additional functions for Wikibase instances that have a SPARQL Query Service (such as Wikidata Query for wikidata.org). SPARQL can be a weird thing at first, but the Wikidata team and community really puts lots of efforts to make things easy with a super rich Wikidata Query Help page, an awesome tool to test you queries and visualize the result, and lots of examples!

• Get JSON from a SPARQL query
• Simplify results
• Pre-baked queries
  • Get entities reverse claims

General helpers

• Work with ids
• Sitelink helper
• Wikibase Time converters

Contributing

Context

This library had for primary purpose to serve the needs of the inventaire project but extending its capabilities to other needs it totally possible: feel welcome to post your suggestions as issues or pull requests!

Design constraints

• wikibase-sdk should stay "small" and dependency-free, so that a web application can include it in its bundle without paying a too high cost for it. A consequence is that the lib generates URLs where other libs would integrate doing the request and parsing it's response. But that actually feels quite right to do this way: simply generating the URLs let's users free to handle requests as they like (with callbacks, promises, async/await, whatever!)
• Therefore, it should focus on providing basic, general helper functions most application working with a Wikibase instance would need.
• Write operations should go into wikibase-edit as it involves working with Wikibase credentials/tokens.
• General command-line interface tools should go to wikibase-cli, very specific ones — wikidata-filter, import-wikidata-dump-to-couchdb, and alikes — should get their own modules.

Donate

We are developing and maintaining tools to work with Wikidata from NodeJS, the browser, or simply the command line, with quality and ease of use at heart. Any donation will be interpreted as a "please keep going, your work is very much needed and awesome. PS: love". Donate

See Also

• wikibase-edit: Edit a Wikibase instance from NodeJS
• wikibase-cli: The command-line interface to Wikibase instances
• wikidata-filter: A command-line tool to filter a Wikidata dump by claim
• wikidata-subset-search-engine: Tools to setup an ElasticSearch instance fed with subsets of Wikidata
• wikidata-taxonomy: Command-line tool to extract taxonomies from Wikidata
• import-wikidata-dump-to-couchdb: Import a subset or a full Wikidata dump into a CouchDB database
• Other Wikidata external tools

You may also like

Do you know Inventaire? It's a web app to share books with your friends, built on top of Wikidata! And its libre software too.

License

MIT

Changelog

7.3.0 - 2020-04-08

• getRevisions: added support for rvprops, rvuser, rvexcludeuser, and rvtag parameters