Function update_citations

bin/update_citations.py:217–268

()

def update_citations():
    authors_from_git = get_authors_from_git()
    existing_authors = get_authors_from_cff_file()

    known_authors = [a for a in authors_from_git if a in KNOWN_AUTHORS]
    human_authors = {a: e for a, e in authors_from_git.items() if not is_nonhuman(a)}
    authors_to_search_for = {
        a: e for a, e in human_authors.items() if a not in known_authors
    }

    unrecognised_authors = {
        a: e
        for a, e in authors_to_search_for.items()
        if not author_found_in_existing_authors(a, existing_authors)
    }

    if not unrecognised_authors:
        return

    for author, email in unrecognised_authors.items():
        print(f"{author} (email(s): {email})")

    while True:
        reply = (
            input("\nThe above authors were not recognised. Add to citations? [y/N] ")
            .lower()
            .strip()
        )
        if not reply or reply[0] == "n":
            return
        if reply[0] == "y":
            break

    new_authors = []
    for author in unrecognised_authors:
        if " " not in author:
            # This is just a GitHub handle, skip
            continue
        first_name, last_name = author.rsplit(maxsplit=1)
        new_authors.append({"family-names": last_name, "given-names": first_name})

    print(f"Adding new authors:\n{new_authors}")

    yaml_file = parse_cff_file()
    yaml_file["authors"].extend(new_authors)

    # Try to preserve indentation and quotes as much as possible
    yaml = YAML()
    yaml.indent(mapping=2, sequence=4, offset=2)
    yaml.preserve_quotes = True
    with open(CITATION_FILE, "w", encoding="UTF-8") as f:
        yaml.dump(yaml_file, f)


if __name__ == "__main__":