sqaaas-reporting-plugins
Officially supported output validators for the SQAaaS platform
Science Score: 44.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
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.2%) to scientific vocabulary
Repository
Officially supported output validators for the SQAaaS platform
Basic Info
- Host: GitHub
- Owner: EOSC-synergy
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Size: 406 KB
Statistics
- Stars: 0
- Watchers: 3
- Forks: 4
- Open Issues: 10
- Releases: 12
Metadata Files
README.md
Reporting plugins (aka validators) for the SQAaaS platform
Institutions owning the result
Achievements
This repository hosts the official set of plugins used to validate the output of the tools used by the SQAaaS solution in order to assess the quality of software, services and their data.
Developer guidelines
As described in
Implement the validate() method,
the validate() method is the pivotal part of the plugin, containing the
business logic that parses and assesses the validity of the tool's output.
What shall the validate() method return?
The object (dict) returned by the validate() method must have:
- valid (type: boolean): sets the criterion validation as successful(True)
or unsuccessful (False)
- subcriteria (type: list): contains a list of objects with the results of
the validation for a given subcriterion. The expected properties of those
objects are:
- id (type: str): identifier of the subcriterion (e.g. QC.Sty01,
QC.Doc06.1)
- valid (type: boolean): whether the subcriterion has passed the validation
(True) or not (False)
- description (type: str): short statement about the subcriterion purpuse
(e.g. "Is LICENSE file placed in the root path of the code repository?")
- evidence (type: str): short statement about the findings (e.g. LICENSE
file is visible at the root path of the code repository )
- standard (type: dict): object with the pointers to the standard where the
criteria belongs to. Expected properties:
- title (type: str): the standard title (e.g. "A set of Common Software
Quality Assurance Baseline Criteria for Research Projects")
- version (type: str): the standard version (e.g. "v4.0")
- url (type: str): URL with the standard location (e.g.
"https://github.com/indigo-dc/sqa-baseline/releases/tag/v4.0")
- data_unstructured (type: dict): object with additional data that will be
shown as it is by the SQAaaS API
How to contribute
Follow the contribution guidelines in order to add a new plugin to the list of supported ones. A peer review of the new contributions is particularly important to ensure the accuracy of the implementation and avoid false positives.
Owner
- Name: Project EOSC-synergy
- Login: EOSC-synergy
- Kind: organization
- Email: coordinator@eosc-synergy.eu
- Website: www.eosc-synergy.eu
- Repositories: 495
- Profile: https://github.com/EOSC-synergy
Citation (CITATION.cff)
# SPDX-FileCopyrightText: Copyright contributors to the Software Quality Assurance as a Service (SQAaaS) project <sqaaas@ibergrid.eu>
# SPDX-FileContributor: 2017-2024 Pablo Orviz <orviz@ifca.unican.es>
#
# SPDX-License-Identifier: GPL-3.0-only
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: SQAaaS API server
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Pablo
family-names: Orviz Fernández
email: orviz@ifca.unican.es
orcid: 'https://orcid.org/0000-0002-2473-6405'
affiliation: Spanish National Research Council (CSIC)
GitHub Events
Total
- Release event: 4
- Watch event: 1
- Delete event: 1
- Push event: 10
- Pull request event: 4
- Create event: 5
Last Year
- Release event: 4
- Watch event: 1
- Delete event: 1
- Push event: 10
- Pull request event: 4
- Create event: 5
Dependencies
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- report2sqaaas 1.4.0
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.4.0 test
- pipelinecomponents/flake8 0.9.0
- python 3.9.12-buster
- report2sqaaas 1.9.0-alpha3
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.9.0-alpha3 test
- report2sqaaas 1.9.0-alpha3
- semver *
- pytest >=6.2.5 test
- pytest-dependency >=0.5.1 test
- report2sqaaas 1.9.0-alpha3 test