rsfc

Repository for development on the Research Software Quality Checks (RSQC) package

https://github.com/oeg-upm/rsfc

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

Repository for development on the Research Software Quality Checks (RSQC) package

Basic Info

Host: GitHub
Owner: oeg-upm
License: mit
Language: Python
Default Branch: main
Size: 254 KB

Statistics

Stars: 1
Watchers: 0
Forks: 1
Open Issues: 3
Releases: 2

Created 9 months ago · Last pushed 6 months ago

Metadata Files

Readme License Citation Codemeta

README.md

Research Software Fairness Checks (RSFC)

A command line interface to automatically evaluate the quality of a Github or Gitlab repository.

Authors: Daniel Garijo, Andrés Montero

Features

Given a repository URL, RSFC will perform a series of checks based on a list of research software quality indicators (RSQI). The RSQIs currently covered by the package are:

softwarehaslicense
softwarehascitation
has_releases
repository_workflows
versioncontroluse
requirements_specified
software_documentation
persistentandunique_identifier
descriptive_metadata
software_tests
archivedinsoftware_heritage
versioningstandardsuse

For more information about these RSQIs, you can check https://github.com/EVERSE-ResearchSoftware/indicators. We have plans to implement all of the RSQIs available in that repository.

Requirements

Python 3.10.8 or higher

Dependencies are available in the requirements.txt or pyproject.toml file located in the root of the repository

Install from PyPI

Just run in your terminal the following command:

pip install rsfc

Install from Github with Poetry

To install the package, first clone the repository in your machine. This project uses Poetry for dependency and environment management.

git clone https://github.com/oeg-upm/rsfc.git

Go to the project's root directory

cd rsfc

Install Poetry (if you haven’t already)

curl -sSL https://install.python-poetry.org | python3 -

Make sure Poetry is available in your PATH

poetry --version

Create the virtual environment and install dependencies

poetry install

Activate the virtual environment (Optional)

source $(poetry env info --path)/bin/activate

Your terminal prompt should now show something like:

(rsfc-py3.11) your-user@your-machine rsfc %

With virtual environment activated you can tried like this:

rsfc --help

Without poetry virtual environment activated you need to use the poetry run:

poetry run rsfc --help

Usage

After installation, you can use the package by running if you activated the poetry env

rsfc <repo_url>

or like this without the poetry env

poetry run rsfc <repo_url>

Owner

Name: Ontology Engineering Group (UPM)
Login: oeg-upm
Kind: organization
Email: oeg-dev@delicias.dia.fi.upm.es
Location: Boadilla del Monte, Madrid, Spain

Website: https://oeg.fi.upm.es/
Repositories: 294
Profile: https://github.com/oeg-upm

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: 'RSFC: Research Software Fairness Checks'
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Daniel
    family-names: Garijo
    email: daniel.garijo@upm.es
    orcid: 'https://orcid.org/0000-0003-0454-7145'
    affiliation: Researcher
  - given-names: Andrés
    family-names: Montero
    email: andres.montero.martin@upm.es
repository-code: 'https://github.com/oeg-upm/rsfc'
keywords:
  - quality
  - fair
  - indicators
  - fairness
license: MIT
version: 0.0.1

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "type": "SoftwareSourceCode",
  "applicationCategory": "Computer Science",
  "author": [
    {
      "id": "https://orcid.org/0000-0003-0454-7145",
      "type": "Person",
      "email": "daniel.garijo@upm.es",
      "familyName": "Garijo",
      "givenName": "Daniel"
    },
    {
      "id": "_:author_2",
      "type": "Person",
      "email": "andres.montero.martin@upm.es",
      "familyName": "Montero",
      "givenName": "Andrs"
    }
  ],
  "codeRepository": "https://github.com/oeg-upm/rsfc",
  "dateCreated": "2025-07-01",
  "description": "Package that performs a series of checks based on a list of research software fairness indicators",
  "isPartOf": "https://everse.software/",
  "keywords": [
    "quality",
    "indicators",
    "fair",
    "fairness"
  ],
  "license": "https://spdx.org/licenses/MIT",
  "name": "RSFC",
  "operatingSystem": "Linux",
  "programmingLanguage": "Python",
  "relatedLink": "https://github.com/EVERSE-ResearchSoftware/indicators",
  "version": "0.0.1",
  "developmentStatus": "wip"
}

GitHub Events

Total

Create event: 1
Release event: 3
Issues event: 2
Push event: 15
Pull request event: 17

Last Year

Create event: 1
Release event: 3
Issues event: 2
Push event: 15
Pull request event: 17

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 2
Total pull requests: 13
Average time to close issues: about 7 hours
Average time to close pull requests: less than a minute
Total issue authors: 1
Total pull request authors: 2
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 2
Pull requests: 13
Average time to close issues: about 7 hours
Average time to close pull requests: less than a minute
Issue authors: 1
Pull request authors: 2
Average comments per issue: 0.0
Average comments per pull request: 0.0
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

dgarijo (2)

Pull Request Authors

juanjemdIos (8)
andriumon (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 31 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 1
Total maintainers: 1

pypi.org: rsfc

EVERSE Research Software Fairness Checks

Homepage: https://github.com/oeg-upm/rsfc
Documentation: https://rsfc.readthedocs.io/
License: MIT
Latest release: 0.0.1
published 7 months ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 31 Last month

Rankings

Dependent packages count: 8.8%

Average: 29.1%

Dependent repos count: 49.4%

Maintainers (1)

dgarijo