feat: conversion now includes an additional validation of the cff output with cffconvert

Author: geoffroy-noel-ddh

.gitignore

@@ -29,3 +29,4 @@ htmlcov/
 # repo-specific
 models/citation_cff/v1_2_0/schema.json
 tests/data/out
+/tmp

codemeta_convert.py

@@ -5,9 +5,21 @@
 from models.codemeta.v3_1.codemeta_pydantic import Software
 from crosswalks.codemeta_to_citation_cff import get_citation_file_format_from_codemeta_software, get_pydantic_model_from_dict
 import sys
+import subprocess
 
 status = 1
 
+def validate_cff(citation_cff_yaml_str):
+    # Assuming the CITATION.cff file is in the current directory
+    result = subprocess.run(["cffconvert", "--validate"], capture_output=True, text=True)
+
+    ret = result.returncode == 0
+    
+    if not ret:
+        print("ERROR: cffconvert validation failed.", result.stderr, file=sys.stderr)
+
+    return ret
+
 def convert(codemeta_path: str):
     # codemeta_path = 'tests/data/in/codemeta-codemeta-3.0.json'
     # codemeta_path = 'tests/data/in/codemeta-isicily.json'
@@ -21,7 +33,7 @@ def convert(codemeta_path: str):
         with open(codemeta_path, 'r') as f:
             codemeta_data = json.load(f)
     except Exception as e:
-        print(f'ERROR: {e}', sys.stderr)
+        print(f'ERROR: {e}', file=sys.stderr)
 
     if codemeta_data:
         codemeta_software = get_pydantic_model_from_dict(codemeta_data, Software)
@@ -30,8 +42,11 @@ def convert(codemeta_path: str):
             citation_cff = get_citation_file_format_from_codemeta_software(codemeta_software)
 
             if citation_cff:
-                print(to_yaml_str(citation_cff, exclude_none=True))
-                ret = 0
+                citation_cff_yaml_str = to_yaml_str(citation_cff, exclude_none=True)
+                print(citation_cff_yaml_str)
+                
+                if validate_cff(citation_cff_yaml_str):
+                    ret = 0
 
     return ret
 

requirements.txt

@@ -3,4 +3,4 @@ pyld==3.1.0                         # TODO: check what this is needed for
 datamodel-code-generator==0.66.0    # to convert cff json-schema into Pydantic models
 pydantic_yaml==1.7.0                # to serialise cff model instance into yaml
 pydantic2-schemaorg==0.3.0          # schema.org classes already encoded as Pydantic model
-
+cffconvert==2.0.0                   # for CITATION.cff -> bibtex output