Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/acdh-oeaw/arche-ref-sources

https://github.com/acdh-oeaw/arche-ref-sources

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary

Keywords

arche
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: acdh-oeaw
  • License: mit
  • Language: PHP
  • Default Branch: master
  • Homepage:
  • Size: 124 KB
Statistics
  • Stars: 0
  • Watchers: 5
  • Forks: 0
  • Open Issues: 1
  • Releases: 18
Topics
arche
Created about 4 years ago · Last pushed 9 months ago
Metadata Files
Readme License

README.md

arche-ref-sources

Build status Coverage Status

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 repo-ingestion@hephaistos.arz.oeaw.ac.at

The script is already installed on repo-ingestion@hephaistos.arz.oeaw.ac.at

  • 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.

Owner

  • Name: Austrian Centre for Digital Humanities & Cultural Heritage
  • Login: acdh-oeaw
  • Kind: organization
  • Email: acdh@oeaw.ac.at
  • Location: Vienna, Austria

GitHub Events

Total
  • Create event: 2
  • Release event: 2
  • Issues event: 6
  • Issue comment event: 3
  • Push event: 14
Last Year
  • Create event: 2
  • Release event: 2
  • Issues event: 6
  • Issue comment event: 3
  • Push event: 14

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 61
  • Total Committers: 2
  • Avg Commits per committer: 30.5
  • Development Distribution Score (DDS): 0.033
Past Year
  • Commits: 27
  • Committers: 1
  • Avg Commits per committer: 27.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Mateusz Żółtak z****k@z****g 59
Martina b****s 2
Committer Domains (Top 20 + Academic)
zozlak.org: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 15
  • Total pull requests: 0
  • Average time to close issues: 10 months
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 0.53
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: 7 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.5
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • zozlak (14)
  • csae8092 (1)
Pull Request Authors
Top Labels
Issue Labels
enhancement (12) bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • packagist 2,131 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 19
  • Total maintainers: 1
packagist.org: acdh-oeaw/arche-ref-sources

Library for fetching data from external reference sources

  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 2,131 Total
Rankings
Dependent packages count: 19.1%
Forks count: 24.6%
Stargazers count: 32.6%
Dependent repos count: 33.5%
Average: 35.4%
Downloads: 67.2%
Maintainers (1)
zozlak
Funding
Last synced: 6 months ago

Dependencies

composer.json packagist
  • phpstan/phpstan * development
  • phpunit/phpunit * development
  • acdh-oeaw/arche-assets ^3.2
  • acdh-oeaw/arche-lib *
  • acdh-oeaw/uri-normalizer ^1.1
  • guzzlehttp/guzzle ^7 | ^6
  • php >=8
  • psr/log *
  • zozlak/argparse *