Programmatic evaluation¶
FAIRsoft indicators can be computed programmatically starting from either:
- one or more GitHub repositories
- existing software metadata that you already maintain elsewhere
Choose the workflow that best matches your starting point.
Available workflows¶
Evaluate GitHub repositories¶
Use this workflow when you want to start from one or more GitHub repository URLs.
Metadata is first extracted automatically from the repository, then optionally reviewed or enriched before computing FAIRsoft indicators.
→ Quickstart: run a minimal script for one or more repositories
→ Full workflow: learn the complete workflow, including metadata extraction, inspection, and enrichment
Evaluate existing metadata¶
Use this workflow when you already have software metadata and want to send it directly for FAIRsoft evaluation.
→ Quickstart: send a minimal metadata object and compute FAIRsoft indicators → Quickstart:
Supporting guides¶
These pages provide reference material used across workflows:
- Accepted metadata structure: expected structure of the
tool_metadataobject - Metadata enrichment: how to improve metadata before evaluation