acdh-oeaw/arche-ref-sources

Library for fetching data from external reference sources

1.0.0 2024-11-27 15:27 UTC

Requires

• php: ^8.1
• acdh-oeaw/arche-assets: ^3.8.1
• acdh-oeaw/arche-lib: ^7
• acdh-oeaw/uri-normalizer: ^3
• psr/log: ^3
• zozlak/argparse: ^1
• zozlak/logging: ^1.0

Requires (Dev)

• acdh-oeaw/arche-lib-ingest: ^4.0
• phpstan/phpstan: ^1
• phpunit/phpunit: ^10

MIT

• Mateusz Żółtak

README

A script for enhancing an ARCHE Suite repository data with information gathered from external reference sources (Geonames, GND, wikidata, etc.).

It works by resolving existing identifiers that are external reference source URIs, fetching information from there and updating a corresponding ARCHE Suite repository resource.

Installation

• run composer require acdh-oeaw/arche-ref-sources

or

• clone this repo and enter its directory
• run composer update

Configuration

See the config-sample.yaml provided by this repository for an example.

Running

• If you installed using composer: vendor/bin/arche-ref-sources in the directory where you run the composer command.
• If you cloned this repo: php -f arche-ref-sources in the directory containing the repository.

Remarks (substitute {arche-ref-source} according to the instruction above):

• Run {arche-ref-source} --help to get the list of available options.
• Run {arche-ref-source} {all the parameters you may want} pathToConfigFile.yaml
  • You need a configuration file. You can use config-sample.yaml provided by this repository as a base (it contains useful comments).
  • For starters you will probably want to stick to the default parse mode (only fetch data from the external source but don't try to update ARCHE) with --verbose (to see what has been fetched and extracted) and maybe --output (so what has been fetched and extracted is saved in a TTL file you can use later on)
  • For filtering resources you can use --id (process exactly one resource with a given id; id namespace doesn't count), --after someDate (process only resources modified afer a given date) and maybe --limit N (process only number of N resources)
  • You can choose the ARCHE instance by providing the --repoUrl (the default is apollo, for minerva you should use --repoUrl https://arche-dev.acdh-dev.oeaw.ac.at/api)
  • You can also read data from an RDF file instead of an ARCHE repository using the --inputFile parameter.

Instructions for [e-mail]

The script is already installed on [e-mail]

• ssh to repo-ingestion@hephaistos
• run ./login.sh
• run /ARCHE/vendor/bin/arche-ref-sources {parameters} {pathToConfigFile} and replace the part in {} with your choice of parameters
  • Example 1: fetch data without changing what is there for resources modified after 01.12.2021, output on console what has been fetched and also write this output to a file:
    • /ARCHE/vendor/bin/arche-ref-sources --mode parse --verbose --output /ARCHE/staging/enrichment/outputEnrich.ttl --after 2021-12-01 /ARCHE/vendor/acdh-oeaw/arche-ref-sources/config-sample.yaml
  • Example 2, not for the faint of heart: fetch data and change on instance, but immediately revert changes; also output on console what has been fetched and write this output to a file as well:
    • /ARCHE/vendor/bin/arche-ref-sources --mode test --verbose --output /ARCHE/staging/enrichment/outputEnrich.ttl /ARCHE/vendor/acdh-oeaw/arche-ref-sources/config-sample.yaml
  • If you want to use your own config file, make a copy of /ARCHE/vendor/acdh-oeaw/arche-ref-sources/config-sample.yaml (cp /ARCHE/vendor/acdh-oeaw/arche-ref-sources/config-sample.yaml {placeOfYourChoice) and edit it.