rs-metadata

Generates and defines the LUMC CodeMeta profile with CodeMeta 3.1 vocabulary. It also checks consistency across the metadata in a repository. The project supports LUMC Research Software guidelines on metadata.

Quick start

pip install rs-metadata
rs-metadata init

init creates missing codemeta.json, CITATION.cff, and CI workflow files. It uses metadata files and the git remote where possible, and it never overwrites existing files.

rs-metadata validate

tells you if you still missing real values.

Background

• Where this came from

Using rs-metadata

• Getting started
• The LUMC CodeMeta profile
• Diagnostics
• Running rs-metadata
• Frequently asked questions
• Release checklist

Developing rs-metadata

• Architecture
• Design decisions
• Recipes
• Adding support for a metadata format
• The consistency model
• Crosswalk reference
• The report contract
• Releasing

Reference

• API reference