wikidata-sdk - npm Package Compare versions

Comparing version 2.5.0 to 2.6.0

package.json

 {
   "name": "wikidata-sdk",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "a javascript tool suite to query and work with wikidata data",
   "main": "build/wikidata-sdk.js",
+  "bin": {
+    "qlabel": "./bin/qlabel",
+    "wikiqid": "./bin/wikiqid"
+  },
   "directories": {
@@ -40,4 +44,7 @@ "test": "tests"
   "devDependencies": {
+    "bluereq": "^2.1.0",
     "coffee-script": "^1.9.3",
     "coffeelint": "^1.10.1",
+    "colors": "^1.1.2",
+    "copy-paste": "^1.2.0",
     "lodash": "^3.10.1",
@@ -44,0 +51,0 @@ "mocha": "^2.2.5",

README.md

@@ -33,3 +33,6 @@ ![wikidata](https://pbs.twimg.com/profile_images/2498571390/cizdiwz4oiiq1zae94jp.png)
   - [Other utils](#other-utils)
-- [A little CoffeeScript / Promises workflow demo](#a-little-coffeescript--promises-workflow-demo)
+  - [A little CoffeeScript / Promises workflow demo](#a-little-coffeescript--promises-workflow-demo)
+- [Command Line Interface](#cli)
+  - [qlabel](#qlabel)
+  - [wikiqid](#wikiqid)
 - [License](#license)
@@ -404,3 +407,36 @@
 
+## CLI
+Now some sweeties from the command line!
+Executables are regrouped in the `bin` folder, so you can execute them using there file path (ex: `./bin/qlabel`), but it is way more convenient to have them globally accessible (ex: `qlabel`), and for that, `wikidata-sdk` must be installed globally:
+```sh
+npm install -g wikidata-sdk
+```
+
+### qlabel
+Working with Wikidata, we often end up with obscure ids. We can always look-up those ids labels on the website but that means loading pages and pages, when a small API call and parsing could return just what we need: a label
+```sh
+qlabel Q1103345
+# => The Cluetrain Manifesto
+```
+By default, the result is in English, but we can pass a 2-letters language code as second argument
+```sh
+qlabel Q1103345 de
+# => Cluetrain-Manifest
+```
+
+### wikiqid
+This one is kind of the other way around: pass it the title of a Wikipedia article and it will return the corresponding Wikidata id
+```sh
+wikiqid Cantabria
+# => Q3946
+wikiqid New Delhi
+# => Q987
+```
+By default, it will look at the English Wikipedia, but you can specify another language by passing a 2-letters language code as last argument
+```sh
+wikiqid science politique fr
+# => Q36442
+```
+
 # License
 [MIT](LICENSE.md)

No alert changes

Improved metrics

Total package byte prevSize

232466

increased by1.82%

Number of package files

56

increased by7.69%

Lines of code

6963

increased by0.13%

Number of lines in readme file

441

increased by8.89%

Worsened metrics

Dev dependency count

9

increased by50%

No dependency changes