Skip to content

feat(generate_techradar_markdowns.py): added RSQKit line#221

Closed
kennethrioja wants to merge 1 commit intoEVERSE-ResearchSoftware:mainfrom
kennethrioja:rsqkit-to-md
Closed

feat(generate_techradar_markdowns.py): added RSQKit line#221
kennethrioja wants to merge 1 commit intoEVERSE-ResearchSoftware:mainfrom
kennethrioja:rsqkit-to-md

Conversation

@kennethrioja
Copy link

@kennethrioja kennethrioja commented Nov 20, 2025

For #216 to work, we must write the RSQKit links in the .md files. However, .md files are generated by scripts/generate_techradar_markdowns.py – this PR is my suggestion to insert RSQKit links to each .md files without manually changing each .md files as suggested by the beginning of #220.

While testing, please amend data/software/pytest.json with the following:

{
  "@context": "https://w3id.org/everse/rs#",
  "@id": "https://w3id.org/everse/tools/pytest",
  "@type": "schema:SoftwareApplication",
  "name": "pytest",
  "description": "Comprehensive testing framework for Python that enhances research software reliability and maintainability through advanced testing capabilities, fixtures, and plugins, supporting test-driven development practices essential for research software quality assurance.",
  "url": "https://docs.pytest.org/",
  "isAccessibleForFree": true,
  "hasQualityDimension": [
    {
      "@id": "dim:maintainability",
      "@type": "@id"
    },
    {
      "@id": "dim:reliability",
      "@type": "@id"
    }
  ],
  "howToUse": ["command-line", "CI/CD"],
  "appliesToProgrammingLanguage": ["Python"],
  "license": "https://opensource.org/licenses/MIT",
  "applicationCategory": [
    {
      "@id": "rs:AnalysisCode",
      "@type": "@id"
    },
    {
      "@id": "rs:ResearchInfrastructureSoftware",
      "@type": "@id"
    }
  ],
  "rsqkit": [
    {
      "title": "Testing software",
      "url": "https://everse.software/RSQKit/testing_software"
    },
    {
      "title": "Task automation using GitHub Actions",
      "url": "https://everse.software/RSQKit/task_automation_github_actions"
    }
  ]
}

I have added an rsqkit array of objects, each having title and url as keys.

Once the python script run, it should add a line See more in RSQKit: <list-of-rsqkit-pages> in tools' .md pages when having at least one RSQKit related page.

I must also change Contributing.md once the .json labels/keys are validated.

@kennethrioja
Copy link
Author

As said by Thomas in #220 (comment), do not touch the .json files
I will close this PR then

@vuillaut
Copy link
Contributor

do not touch the .json files

Just to avoid any misunderstanding, this is not what I said 😆
The JSON files can and should be updated (contributions are even welcome), but within the constraints of the defined software schema (which can also be updated if needs be).

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.

2 participants