SALTbot: Software and Article Linker Toolbot

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

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

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

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

python SALTbot.py run  [ARGS]

For more info, run:

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}
 }