saltbot

Software and Article Linker Toolbot

https://github.com/softwareunderstanding/saltbot

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 1 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 (13.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Software and Article Linker Toolbot

Basic Info
  • Host: GitHub
  • Owner: SoftwareUnderstanding
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 882 KB
Statistics
  • Stars: 4
  • Watchers: 2
  • Forks: 1
  • Open Issues: 4
  • Releases: 1
Created almost 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

SALTbot: Software and Article Linker Toolbot

Project Status: Active – The project has reached a stable, usable state and is being actively developed. DOI

DESCRIPTION

This repository contains the implementation of a tool designed to link Scientific Articles and their Software pages on Wikibase graphs.

SALTBot is proposed as a Wikidata bot, with its own page here. It is maintained and run by the Ontology Engineering Group and Universidad Politécnica de Madrid.

INSTALLATION

It is required to have an environment with at least Python 3.9

1-. Clone repository

2-. Install requirements console pip install -r requirements.txt 3-. Install and configure SOMEF a Python library for extracting software metadata from a code repository. https://github.com/KnowledgeCaptureAndDiscovery/somef

USAGE

Configure

Before running SALTbot, you must first configure your login credentials and wikibase using the configure command console python SALTbot.py configure You can invoke this command using -a as argument to skip the Wikibase configuration and target Wikidata automatically SALTbot will then prompt you for you login information and the required wikibase URLs. If left blank, the URLs will default to Wikidata's respective values An example of the Wikibase configuration using Wikidatas values would be the following

console MEDIAWIKI_API_URL = https://www.wikidata.org/w/api.php SPARQL_ENDPOINT_URL = https://query.wikidata.org/ WIKIBASE_URL = https://www.wikidata.org

Running

Once configured, execute SALTbot using

console python SALTbot.py run [ARGS]

For more info, run: console python SALTbot.py [COMMAND] --help

## Citation If you use SALTbot, please use the following citation: @software{Bolinches_SALTbot_Software_and_2023, author = {Bolinches, Jorge and Garijo, Daniel}, doi = {10.5281/zenodo.8190001}, month = jul, title = {{SALTbot: Software and Article Linker Toolbot}}, url = {https://github.com/SoftwareUnderstanding/SALTbot}, version = {v0.0.1}, year = {2023} }

Owner

  • Name: Software Understanding
  • Login: SoftwareUnderstanding
  • Kind: organization

Organization dedicated to make software understandable by extracting metadata and facilitate its reuse

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Bolinches"
  given-names: "Jorge"
- family-names: "Garijo"
  given-names: "Daniel"
  orcid: "http://orcid.org/0000-0003-0454-7145"
title: "SALTbot: Software and Article Linker Toolbot"
version: v0.0.1
doi: 10.5281/zenodo.8190001
date-released: 2023-07-27
url: "https://github.com/SoftwareUnderstanding/SALTbot"

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1