jskos-cli

JSKOS Command Line Interface

Command Line Applications to process JSKOS data format.

This repository contains command client applications for working with the JSKOS data format for knowledge organization systems. The applications are basically wrappers around jskos-validate and jskos-tools.

Table of Contents

• Install
• Usage
  • jskos-validate
  • jskos-convert
  • jskos-enrich
• Data flow
• Maintainers
• Publish
• Contributing
• License

Install

Install globally to provide commands jskos-validate and jskos-convert:

npm install -g jskos-cli

Usage

jskos-validate

Validate a set of ndjson files in JSKOS format.

Usage: jskos-validate [options] [type] files...

Options:
  -V, --version  output the version number
  -q, --quiet    suppress status messages
  --list-types   list JSKOS object types
  -v, --verbose  show error messages
  -u, --unknown  allow unknown fields
  -h, --help     output usage information

Examples:
  $ jskos-validate -v concepts concepts.ndjson
  $ jskos-validate -u mappings mappings.ndjson
  $ jskos-validate schemes.ndjson concepts.ndjson

Validation result is emitted in TAP format. Errors are reported as diagnostic lines with record number. If JSKOS is read from standard input, only invalid records are reported. Exit code is the number of errors (up to 100).

jskos-convert

Convert between JSKOS and other formats (by now only CSV and RDF/N-Triples).

Usage: jskos-convert [options] [type] [files...]

Options:
  -V, --version                          output the version number
  -q, --quiet                            suppress status messages
  --list-types                           list JSKOS object types
  -f, --from <format>                    input format (ndjson or csv)
  -t, --to <format>                      output format (ndjson, csv, nt)
  -c, --clean                            cleanup input data
  -v, --validate                         validate and omit invalid records
  -l, --language <lang>                  include labels (use '-' for any language)
  -r, --registry <file>                  registry file with schemes, types... to look up
  -s, --scheme <uri|notation|file>       concept scheme to convert concepts or mappings
  -d, --destination <uri|notation|file>  target scheme to convert mappings
  -p, --partof <uri>                     concordance URI
  -m, --marktop                          explicitly mark concepts without broader as top concepts
  --creator <uri and/or name>            add creator to mappings
  -h, --help                             display help for command

Examples:
  $ jskos-convert mappings -t csv mappings.ndjson
  $ jskos-convert concepts -r registry.json -s example http://example.org/jskos.csv

Concepts in CSV format can be specified with:

• notation to build URIs from
• prefLabel (if default language is specified) and prefLabel@xx (with explicit language code xx)
• altLabel (if default language is specified) and altLabel@xx (with explicit language code xx)
• scopeNote (if default language is specified) and scopeNote@xx (with explicit language code xx)
• level and/or broaderNotation for hierarchies. CSV output uses broaderNotation.

Multi-hierarchies are not supported when converting from and/or to CSV.

Mappings in CSV format can be specified with:

• fromNotation
• fromLabel (if a language is specified, ignored when converting from CSV)
• toNotation
• toLabel (if a language is specified, ignored when converting from CSV)
• type
• creator (URI and/or name, separated by a space, in that order; e.g: "https://github.com/stefandesu Stefan Peters")
• created (Date of creation)
• uri (URI of a mapping)

1-to-n mappings are not supported yet.

jskos-enrich

Usage: jskos-enrich [options] [input.ndjson] [output.ndjson]

Options:
  -V, --version                  Output the version number
  -q, --quiet                    Suppress enrichment warnings (default)
  -v, --verbose                  Show detailed warning and error messages
  --properties <list>            Comma-separated JSKOS properties to enrich
                                 (default: all set-type props:
                                 creator, contributor, source, publisher,
                                 partOf, startPlace, endPlace, place,
                                 replacedBy, basedOn, subject, subjectOf)
  --schemes <file>               Path to a custom configuration file
                                 (default: ./config/default_config.json)
  -h, --help                     Output usage information

Examples:
  # Enrich subjects, creators, etc., using default config, no warnings
  $ jskos-enrich input.ndjson output_enriched.ndjson

  # Enrich only subject and creator fields
  $ jskos-enrich input.ndjson output_enriched.ndjson --properties subject,creator

  # Use a custom scheme configuration and see warnings
  $ jskos-enrich -v input.ndjson output_enriched.ndjson  --schemes ../config/custom_config.json

The jskos-enrich command reads newline-delimited JSKOS records (NDJSON), iterates over specified array-properties (e.g. subject, creator, publisher, etc.), and enriches each entry by adding a prefLabel from external concept registries (e.g. DDC, EuroVoc, ILC) via the configured APIs given in --schemes.

• Input: one JSKOS record per line in input.ndjson

• Output: enriched records written line-by-line to output.ndjson

• --properties <list>
  Target which JSKOS set-type properties to enrich. Provide names separated by commas. Default: "creator,contributor,source,publisher,partOf,startPlace,endPlace,place,replacedBy,basedOn,subject,subjectOf".

• --schemes <file>
  Path to a JSON configuration file that exports an array of scheme definitions, each with:

  • uriPattern for matching URIs
  • API endpoints for enrichment
    Defaults to ./config/default_config.json.

For each record and property, uri or url values are collected, skipping entries already having prefLabel, and corresponding concepts are fetched in parallel via cocoda-sdk. If no prefLabel was found, warnings are emitted in verbose mode.

Data flow

graph TD
   jskosin(JSKOS)
    csvin(CSV)
    report(report)
    jskosout(JSKOS)
    csvout(CSV)
    
    jskosin --> jskos-validate
    jskosin -- schemes, mappings & concepts --> jskos-convert
    csvin -- mappings & concepts --> jskos-convert
    jskosin --> jskos-enrich

    jskos-convert -- mappings & concepts --> csvout
    jskos-convert -- mappings & concepts --> jskosout

    subgraph jskos-cli [ ]
        jskos-validate[**jskos-validate**]
        jskos-convert[**jskos-convert**]
        jskos-enrich[**jskos-enrich**]
    end
    jskos-validate --> report
    jskos-enrich --> JSKOS

Maintainers

• @nichtich
• @rodolv-commons

Publish

Please work on the dev branch during development (or better yet, develop in a feature branch and merge into dev when ready).

When a new release is ready (i.e. the features are finished, merged into dev, and all tests succeed), run the included release script (replace "patch" with "minor" or "major" if necessary):

npm run release:patch # or minor, or major

This will:

• Check that we are on dev
• Run tests and build to make sure everything works
• Make sure dev is up-to-date
• Run npm version patch (or "minor"/"major")
• Push changes to dev
• Switch to main
• Merge changes from dev
• Push main with tags
• Switch back to dev

After running this, GitHub Actions will automatically publish the new version to npm. It will also create a new GitHub Release draft. Please edit and publish the release draft manually.

Contributing

Contributions are welcome! See CONTRIBUTING.md for details!

License

MIT (c) 2020 Verbundzentrale des GBV (VZG)