Skip to content

build online JSON API during doc build#397

Open
vuillaut wants to merge 1 commit into
mainfrom
apitools
Open

build online JSON API during doc build#397
vuillaut wants to merge 1 commit into
mainfrom
apitools

Conversation

@vuillaut
Copy link
Copy Markdown
Contributor

This PR adds API build to get an aggregated JSON file with all tools:

{
  "generatedAt": "2026-05-21T12:24:59.537Z",
  "source": "quality-tools",
  "count": 69,
  "files": [
    "apptainer.json",
    "auto-codemeta.json",
    "bandit.json",
    "bearer.json",
    "black.json",
    "cffinit.json",
    "checkstyle.json",
    "choosealicense.json",
    "cmake.json",
    "codemeta-generator.json",
    "cppcheck.json",
    "cppunit.json",
    "creative-commons-license-chooser.json",
    "dependabot.json",
    "docker.json",
    "doxygen.json",
    "dvc.json",
    "eOSSR.json",
    "fair-aware.json",
    "fair-python-cookiecutter.json",
    "five_recommendations_for_fair_software.json",
    "flake8.json",
    "fuji.json",
    "gcov.json",
    "git.json",
    "github_actions.json",
    "github-copilot.json",
    "gitlab-cicd.json",
    "gitleaks.json",
    "guix.json",
    "hadolint.json",
    "hermes-workflow.json",
    "howfairis.json",
    "javadoc.json",
    "jenkins.json",
    "junit.json",
    "jupyter.json",
    "kubernetes.json",
    "maqao.json",
    "mkdocs.json",
    "nix.json",
    "openssf-scorecard.json",
    "pixi.json",
    "poetry.json",
    "pre-commit.json",
    "pylint.json",
    "pypi.json",
    "pytest.json",
    "qlty.json",
    "renovatebot.json",
    "resqui.json",
    "reuse.json",
    "rsfc.json",
    "ruff.json",
    "scanoss.json",
    "scorep.json",
    "singularityce.json",
    "software-heritage.json",
    "somef-vider.json",
    "somef.json",
    "somesy.json",
    "sonarqube.json",
    "sphinx.json",
    "sqaaas.json",
    "tox.json",
    "travis-ci.json",
    "valgrind.json",
    "zenodo-github-integration.json",
    "zenodo.json"
  ],
  "tools": [
    {
      "@context": "https://w3id.org/everse/rs#",
      "@id": "https://w3id.org/everse/tools/apptainer",
      "@type": "schema:SoftwareApplication",
      "name": "Apptainer",
      "description": "High-performance container platform designed for scientific computing and HPC environments. Enhances **Compatibility** by enabling co-existence of different software stacks on HPC systems and providing interoperability across diverse computing infrastructures without requiring root privileges. Improves **Flexibility** through high adaptability to HPC and scientific computing environments, scalability from laptops to supercomputers, simplified installability with single-file container images, and easy replaceability of software environments. Strengthens **Reliability** by providing fault tolerance through container isolation, improved availability via consistent execution across different systems, and enhanced recoverability with immutable container images. Supports **Sustainability** by ensuring scientific software remains functional across evolving HPC platforms, meeting long-term computational research needs, and maintaining reproducible research environments over time.",
      "url": "https://apptainer.org/",
      "applicationCategory": {
        "@id": "rs:ResearchInfrastructureSoftware",
        "@type": "@id"
      },
      "isAccessibleForFree": true,
      "hasQualityDimension": [
        {
          "@id": "dim:compatibility",
          "@type": "@id"
        },
        {
          "@id": "dim:flexibility",
          "@type": "@id"
        },
        {
          "@id": "dim:reliability",
          "@type": "@id"
        },
        {
          "@id": "dim:sustainability",
          "@type": "@id"
        }
      ],
      "howToUse": [
        "command-line"
      ],
      "license": "https://spdx.org/licenses/BSD-3-Clause",
      "improvesQualityIndicator": [
        {
          "@id": "https://w3id.org/everse/i/indicators/dependency_management",
          "@type": "@id"
        },
        {
          "@id": "https://w3id.org/everse/i/indicators/requirements_specified",
          "@type": "@id"
        }
      ],
      "_filename": "apptainer"
    },
    {
      "@context": "https://w3id.org/everse/rs#",
      "@id": "https://w3id.org/everse/tools/auto-codemeta_generator",
      "@type": "SoftwareApplication",
      "applicationCategory": {
        "@id": "rs:PrototypeTool",
        "@type": "@id"
      },
      "description": "This repository contains a (client-side) web application to automatically generate  Codemeta documents (aka. codemeta.json).",
      "hasQualityDimension": {
        "@id": "dim:fairness",
        "@type": "@id"
      },
      "howToUse": [
        "CI/CD",
        "command-line"
      ],
      "isAccessibleForFree": true,
      "license": "https://spdx.org/licenses/AGPL-3.0-or-later",
      "name": "Auto-CodeMeta Generator",
      "url": "https://w3id.org/autocodemeta",
      "improvesQualityIndicator": [
        {
          "@id": "https://w3id.org/everse/i/indicators/descriptive_metadata",
          "@type": "@id"
        },
        {
          "@id": "https://w3id.org/everse/i/indicators/codemeta_completeness",
          "@type": "@id"
        },
        {
          "@id": "https://w3id.org/everse/i/indicators/metadata_is_up_to_date",
          "@type": "@id"
        },
        {
          "@id": "https://w3id.org/everse/i/indicators/software_has_citation",
          "@type": "@id"
        }
      ],
      "_filename": "auto-codemeta"
    },
    {
      "@context": "https://w3id.org/everse/rs#",
      "@id": "https://w3id.org/everse/tools/bandit",
      "@type": "SoftwareApplication",
      "applicationCategory": {
        "@id": "rs:AnalysisCode",
        "@type": "@id"
      },
      "appliesToProgrammingLanguage": [
        "Python"
      ],
      "description": "Security-focused static analysis tool for Python that identifies common **security** vulnerabilities and anti-patterns in software, helping maintain secure coding practices.",
      "hasQualityDimension": {
        "@id": "dim:security",
        "@type": "@id"
      },
      "howToUse": [
        "CI/CD",
        "command-line"
      ],
      "isAccessibleForFree": true,
      "license": "https://spdx.org/licenses/Apache-2.0",
      "name": "bandit",
      "url": "https://github.com/PyCQA/bandit",
      "improvesQualityIndicator": [
        {
          "@id": "https://w3id.org/everse/i/indicators/static_analysis_common_vulnerabilities",
          "@type": "@id"
        }
      ],
      "_filename": "bandit"
    },
...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant