Skip to content

CodeMeta Generator

osa_tool.operations.docs.community_docs_generation.codemeta_generator

Generator for codemeta.json — a JSON-LD metadata file following the CodeMeta standard (https://codemeta.github.io/) for FAIR research-software compliance.

The generator extracts metadata from RepositoryMetadata and, when available, from the repository's pyproject.toml to produce a self-describing codemeta.json placed at the repository root.

CodeMetaGenerator

Builds a codemeta.json file from repository metadata.

The generated file follows the CodeMeta 3.0 JSON-LD context and includes the core recommended fields for research software discoverability.

generate()

Generate codemeta.json and write it to the repository root.

Returns:

Name Type Description
str str

Absolute path to the generated file.