search

Materials-Data-Science-and-Informatics / somesy

A CLI tool for synchronizing software project metadata
https://materials-data-science-and-informatics.github.io/somesy/main/
MIT License
12 stars 2 forks source link

Pydantic complains about missing email #80

Closed flrnslbch closed 7 months ago

flrnslbch commented 8 months ago

Describe the bug The person idenfication heuristics give the impression that the email address is optional when specifying people. This is also necessary, if an author wishes to be listed by name only. However, when I omit the email address in somesy.toml, I get the following error:

Error: 1 validation error for SomesyInput                                                                                                                                                                                     
project.people.3.email                                                                                                                                                                                                        
  Field required                                                                                                                                                                                                              
    For further information visit https://errors.pydantic.dev/2.5/v/missing

To Reproduce

Run somesy sync on an input file that contains a person for which no email is supplied.

Expected behavior No email is listed for this person in the output files

Environment Provide information about versions of relevant software packages.

mustafasoylu commented 7 months ago

Most of the Author metadata like in pyproject.toml requires an email since their format is author_full_name <euthor_email>. Therefore, we made family names, given names, andemail required fields. In person heuristics, what we would like to have is actually an orcid profile, which is better for recognizing humans since emails change with affiliation too.

flrnslbch commented 6 months ago

Neither pyproject nor CITATION.cff require an email. I do not understand why somesy needs to be stricter than the output standards. For privacy reasons and/or to avoid spam authors may choose to not supply an email adress which in my opinion should be respected. Please consider reopening this issue.