feat: allow custom field overrides when converting

Author: sgfost

README.md

@@ -101,7 +101,9 @@ codemeta = CodeMeta(
   author=Person(givenName="Dale", familyName="Earnhardt"),
 )
 
-cff = convert("codemeta", "cff", codemeta)
+# commit kwarg is an override that can be used to insert
+# a custom field into the resulting metadata after conversion
+cff = convert("codemeta", "cff", codemeta, commit="abcdef123456789")
 
 print(codemeta.json(indent=True))
 # {
@@ -119,6 +121,7 @@ print(cff.yaml())
 # message: If you use this software, please cite it using the metadata from this file.
 # title: My Project
 # type: software
+# commit: abcdef123456789
 ```
 
 <!-- ### As a Github Action -->

codemeticulous/cff/convert.py

@@ -211,7 +211,7 @@ def extract_main_url_from_codemeta(data: CodeMeta) -> str:
     )
 
 
-def canonical_to_cff(data: CanonicalCodeMeta) -> CitationFileFormat:
+def canonical_to_cff(data: CanonicalCodeMeta, **custom_fields) -> CitationFileFormat:
     """Extract all possible Citation File Format fields from a CodeMeta object based
     on the CodeMeta crosswalk and return a CitationFileFormat object
     """
@@ -245,6 +245,7 @@ def canonical_to_cff(data: CanonicalCodeMeta) -> CitationFileFormat:
         type="software",
         url=extract_main_url_from_codemeta(data),
         version=data.version,
+        **custom_fields,
     )
 
 

codemeticulous/codemeta/convert.py

@@ -2,8 +2,8 @@
 from codemeticulous.codemeta.models import CodeMeta
 
 
-def canonical_to_codemeta(data: CanonicalCodeMeta) -> CodeMeta:
-    return CodeMeta(**data.dict())
+def canonical_to_codemeta(data: CanonicalCodeMeta, **custom_fields) -> CodeMeta:
+    return CodeMeta(**data.dict(), **custom_fields)
 
 
 def codemeta_to_canonical(data: CodeMeta) -> CanonicalCodeMeta:

codemeticulous/convert.py

@@ -41,15 +41,15 @@ def to_canonical(source_format: str, source_data):
     return canonical_instance
 
 
-def from_canonical(target_format: str, canonical_instance):
+def from_canonical(target_format: str, canonical_instance, **custom_fields):
     canonical_to_target = STANDARDS[target_format]["from_canonical"]
-    target_instance = canonical_to_target(canonical_instance)
+    target_instance = canonical_to_target(canonical_instance, **custom_fields)
 
     return target_instance
 
 
-def convert(source_format: str, target_format: str, source_data):
+def convert(source_format: str, target_format: str, source_data, **custom_fields):
     # FIXME: add tons of error handling
 
     canonical_instance = to_canonical(source_format, source_data)
-    return from_canonical(target_format, canonical_instance)
+    return from_canonical(target_format, canonical_instance, **custom_fields)

codemeticulous/datacite/convert.py

@@ -171,7 +171,7 @@ def codemeta_language_fileformat_to_datacite_format(
     return formats or None
 
 
-def canonical_to_datacite(data: CanonicalCodeMeta, ignore_existing_doi=False) -> DataciteV45:
+def canonical_to_datacite(data: CanonicalCodeMeta, ignore_existing_doi=False, **custom_fields) -> DataciteV45:
     primary_doi = (
         extract_doi_from_identifier(data.identifier)
         if not ignore_existing_doi
@@ -232,6 +232,7 @@ def canonical_to_datacite(data: CanonicalCodeMeta, ignore_existing_doi=False) ->
         # codemeta.funding is a plain string, can't really ensure that the string
         # is the required name field
         # fundingReferences=None,
+        **custom_fields,
     )