Data

Tools

Indexes

Applications

Experiments

Open Source Science

kalamar-plugin-externalresources

Plugin to link external resources like full texts to query hits

https://github.com/korap/kalamar-plugin-externalresources

Science Score: 67.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

Plugin to link external resources like full texts to query hits

Basic Info
  • Host: GitHub
  • Owner: KorAP
  • License: bsd-2-clause
  • Language: Go
  • Default Branch: master
  • Size: 359 KB
Statistics
  • Stars: 0
  • Watchers: 6
  • Forks: 0
  • Open Issues: 2
  • Releases: 6
Created over 3 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Citation

README.md

Kalamar-Plugin-ExternalResources

DOI

Description

Kalamar-Plugin-ExternalResources is a web service that integrates in the plugin framework of Kalamar, to allow linking texts by their text sigle to external data providers, mainly for full text access.

Kalamar-Plugin-ExternalResources is meant to be a basic plugin and should demonstrate and evaluate the plugin capabilities of Kalamar.

This is software in an early development stage. Its behaviour may change without warnings!

Prerequisites

Go 1.19 or later

Build

To build the latest version of Kalamar-Plugin-ExternalResources, do ...

shell git clone https://github.com/KorAP/Kalamar-Plugin-ExternalResources cd Kalamar-Plugin-ExternalResources go test . go build .

Running

The binary can be started without prerequisites. The templates folder has to be kept in the root directory. A db folder contains the database.

Registration of the plugin in Kalamar is not yet officially supported - but it works by passing the JSON blob generated at /plugin.json to the plugin registration handler.

Indexation

To index further data, the mappings need to be stored in a csv-file, like

csv "WPD11/A00/00001","Wikipedia","http://de.wikipedia.org/wiki/Alan_Smithee" "WPD11/A00/00003","Wikipedia","http://de.wikipedia.org/wiki/Actinium" "WPD11/A00/00005","Wikipedia","http://de.wikipedia.org/wiki/Ang_Lee"

With the first column being the textSigle (aka the document identifier), the second being the provider name and the third being the URL. These files can be gzipped as well. Then run the indexation with:

shell ./Kalamar-Plugin-ExternalResources data.csv

Customization

The following environment variables can be set either as environment variables or via .env file in the calling directory.

  • KORAP_SERVER: The server URL of the hosting service.
  • KORAP_EXTERNAL_RESOURCES_PORT: The port the service should be listen to.
  • KORAP_EXTERNAL_RESOURCES: The exposed URL the service is hosted.

Dockerization

Kalamar-Plugin-ExternalResources is available as a docker image on Docker Hub.

To build an image yourself based on the provided Dockerfile, run

shell docker build \ -f Dockerfile \ -t korap/kalamar-plugin-externalresources .

To create a container on Linux based on the image with a mounted database in db and a configuration file, run

shell docker run \ --rm \ --network host \ -v ${PWD}/db/:/db/:z \ -v ${PWD}/.env:/.env \ korap/kalamar-plugin-externalresources

To index using docker, run

shell docker run \ --rm \ --network host \ -v ${PWD}/db/:/db/:z \ -v ${PWD}/data/:/data \ -v ${PWD}/.env:/.env \ korap/kalamar-plugin-externalresources \ data/data.csv.gz

License

Copyright (c) 2023-2025, IDS Mannheim, Germany
Author: Nils Diewald

Kalamar-Plugin-ExternalResources is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for the German Language (IDS).

Kalamar-Plugin-ExternalResources is published under the BSD-2 License.

Owner

  • Name: KorAP
  • Login: KorAP
  • Kind: organization
  • Location: Mannheim, Germany

Corpus Analysis Platform by the Leibniz Institute for the German Language

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Kalamar-Plugin-ExternalResources
message: Plugin to link external resources like full texts to query hits
type: software
authors:
  - orcid: 'https://orcid.org/0000-0002-2993-9180'
    affiliation: Leibniz Institute for the German Language
    given-names: Nils
    family-names: Diewald
repository-code: 'https://github.com/KorAP/Kalamar-Plugin-ExternalResources/'
url: 'https://korap.ids-mannheim.de/'
license: BSD-2-Clause

GitHub Events

Total
  • Release event: 1
  • Delete event: 12
  • Issue comment event: 13
  • Push event: 12
  • Pull request event: 21
  • Create event: 16
Last Year
  • Release event: 1
  • Delete event: 12
  • Issue comment event: 13
  • Push event: 12
  • Pull request event: 21
  • Create event: 16

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 0
  • Total pull requests: 15
  • Average time to close issues: N/A
  • Average time to close pull requests: 17 days
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.13
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 15
Past Year
  • Issues: 0
  • Pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: 18 days
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.14
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 7
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (22)
Top Labels
Issue Labels
Pull Request Labels
dependencies (22) go (6)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 16
proxy.golang.org: github.com/KorAP/Kalamar-Plugin-ExternalResources
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.8%
Average: 6.0%
Dependent repos count: 6.2%
Last synced: 9 months ago
proxy.golang.org: github.com/korap/kalamar-plugin-externalresources
  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 8.3%
Average: 8.9%
Dependent repos count: 9.4%
Last synced: 10 months ago