Skip to content

inject

inject_config(all_contributors_rc, contributors)

Replace the 'contributors' field of an all contributors configuration JSON dict with a new list

Returns:

Name Type Description
dict dict[Any]

Updated .all-contributorsrc config in JSON dict format
Source code in all_all_contributors/inject.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
def inject_config(all_contributors_rc: dict[Any], contributors: list[Any]) -> dict[Any]:
    """Replace the 'contributors' field of an all contributors configuration
    JSON dict with a new list

    Returns:
        dict: Updated .all-contributorsrc config in JSON dict format
    """
    if "contributors" in all_contributors_rc.keys():
        all_contributors_rc["contributors"] = contributors
    else:
        raise AttributeError("All contributors file is missing 'contributors' field")

    validate_all_contributors_rc(all_contributors_rc)
    return all_contributors_rc