build_tools/generate_authors_table.py

"""
This script generates an html table of contributors, with names and avatars.
The list is generated from scikit-learn's teams on GitHub, plus a small number
of hard-coded contributors.

The table should be updated for each new inclusion in the teams.
Generating the table requires admin rights.
"""

import getpass
import sys
import time
from os import path
from pathlib import Path

import requests

print("Input user:", file=sys.stderr)
user = input()
token = getpass.getpass("Input access token:\n")
auth = (user, token)

LOGO_URL = "https://avatars2.githubusercontent.com/u/365630?v=4"
REPO_FOLDER = Path(path.abspath(__file__)).parent.parent


def get(url):
    for sleep_time in [10, 30, 0]:
        reply = requests.get(url, auth=auth)
        api_limit = (
            "message" in reply.json()
            and "API rate limit exceeded" in reply.json()["message"]
        )
        if not api_limit:
            break
        print("API rate limit exceeded, waiting..")
        time.sleep(sleep_time)

    reply.raise_for_status()
    return reply


def get_contributors():
    """Get the list of contributor profiles. Require admin rights."""
    # get core devs and contributor experience team
    core_devs = []
    documentation_team = []
    contributor_experience_team = []
    comm_team = []
    core_devs_slug = "core-devs"
    contributor_experience_team_slug = "contributor-experience-team"
    comm_team_slug = "communication-team"
    documentation_team_slug = "documentation-team"

    entry_point = "https://api.github.com/orgs/scikit-learn/"

    for team_slug, lst in zip(
        (
            core_devs_slug,
            contributor_experience_team_slug,
            comm_team_slug,
            documentation_team_slug,
        ),
        (core_devs, contributor_experience_team, comm_team, documentation_team),
    ):
        print(f"Retrieving {team_slug}\n")
        for page in [1, 2]:  # 30 per page
            reply = get(f"{entry_point}teams/{team_slug}/members?page={page}")
            lst.extend(reply.json())

    # get members of scikit-learn on GitHub
    print("Retrieving members\n")
    members = []
    for page in [1, 2, 3]:  # 30 per page
        reply = get(f"{entry_point}members?page={page}")
        members.extend(reply.json())

    # keep only the logins
    core_devs = set(c["login"] for c in core_devs)
    documentation_team = set(c["login"] for c in documentation_team)
    contributor_experience_team = set(c["login"] for c in contributor_experience_team)
    comm_team = set(c["login"] for c in comm_team)
    members = set(c["login"] for c in members)

    # add missing contributors with GitHub accounts
    members |= {"dubourg", "mbrucher", "thouis", "jarrodmillman"}
    # add missing contributors without GitHub accounts
    members |= {"Angel Soler Gollonet"}
    # remove CI bots
    members -= {"sklearn-ci", "sklearn-wheels", "sklearn-lgtm"}
    contributor_experience_team -= (
        core_devs  # remove ogrisel from contributor_experience_team
    )

    emeritus = (
        members
        - core_devs
        - contributor_experience_team
        - comm_team
        - documentation_team
    )

    # hard coded
    emeritus_contributor_experience_team = {
        "cmarmo",
    }
    emeritus_comm_team = {"reshamas"}

    # Up-to-now, we can subtract the team emeritus from the original emeritus
    emeritus -= emeritus_contributor_experience_team | emeritus_comm_team

    comm_team -= {"reshamas"}  # in the comm team but not on the web page

    # get profiles from GitHub
    core_devs = [get_profile(login) for login in core_devs]
    emeritus = [get_profile(login) for login in emeritus]
    contributor_experience_team = [
        get_profile(login) for login in contributor_experience_team
    ]
    emeritus_contributor_experience_team = [
        get_profile(login) for login in emeritus_contributor_experience_team
    ]
    comm_team = [get_profile(login) for login in comm_team]
    emeritus_comm_team = [get_profile(login) for login in emeritus_comm_team]
    documentation_team = [get_profile(login) for login in documentation_team]

    # sort by last name
    core_devs = sorted(core_devs, key=key)
    emeritus = sorted(emeritus, key=key)
    contributor_experience_team = sorted(contributor_experience_team, key=key)
    emeritus_contributor_experience_team = sorted(
        emeritus_contributor_experience_team, key=key
    )
    documentation_team = sorted(documentation_team, key=key)
    comm_team = sorted(comm_team, key=key)
    emeritus_comm_team = sorted(emeritus_comm_team, key=key)

    return (
        core_devs,
        emeritus,
        contributor_experience_team,
        emeritus_contributor_experience_team,
        comm_team,
        emeritus_comm_team,
        documentation_team,
    )


def get_profile(login):
    """Get the GitHub profile from login"""
    print("get profile for %s" % (login,))
    try:
        profile = get("https://api.github.com/users/%s" % login).json()
    except requests.exceptions.HTTPError:
        return dict(name=login, avatar_url=LOGO_URL, html_url="")

    if profile["name"] is None:
        profile["name"] = profile["login"]

    # fix missing names
    missing_names = {
        "bthirion": "Bertrand Thirion",
        "dubourg": "Vincent Dubourg",
        "Duchesnay": "Edouard Duchesnay",
        "Lars": "Lars Buitinck",
        "MechCoder": "Manoj Kumar",
    }
    if profile["name"] in missing_names:
        profile["name"] = missing_names[profile["name"]]

    return profile


def key(profile):
    """Get a sorting key based on the lower case last name, then firstname"""
    components = profile["name"].lower().split(" ")
    return " ".join([components[-1]] + components[:-1])


def generate_table(contributors):
    lines = [
        ".. raw :: html\n",
        "    <!-- Generated by generate_authors_table.py -->",
        '    <div class="sk-authors-container">',
        "    <style>",
        "      img.avatar {border-radius: 10px;}",
        "    </style>",
    ]
    for contributor in contributors:
        lines.append("    <div>")
        lines.append(
            "    <a href='%s'><img src='%s' class='avatar' /></a> <br />"
            % (contributor["html_url"], contributor["avatar_url"])
        )
        lines.append("    <p>%s</p>" % (contributor["name"],))
        lines.append("    </div>")
    lines.append("    </div>")
    return "\n".join(lines) + "\n"


def generate_list(contributors):
    lines = []
    for contributor in contributors:
        lines.append("- %s" % (contributor["name"],))
    return "\n".join(lines) + "\n"


if __name__ == "__main__":
    (
        core_devs,
        emeritus,
        contributor_experience_team,
        emeritus_contributor_experience_team,
        comm_team,
        emeritus_comm_team,
        documentation_team,
    ) = get_contributors()

    print("Generating rst files")
    with open(
        REPO_FOLDER / "doc" / "maintainers.rst", "w+", encoding="utf-8"
    ) as rst_file:
        rst_file.write(generate_table(core_devs))

    with open(
        REPO_FOLDER / "doc" / "maintainers_emeritus.rst", "w+", encoding="utf-8"
    ) as rst_file:
        rst_file.write(generate_list(emeritus))

    with open(
        REPO_FOLDER / "doc" / "contributor_experience_team.rst", "w+", encoding="utf-8"
    ) as rst_file:
        rst_file.write(generate_table(contributor_experience_team))

    with open(
        REPO_FOLDER / "doc" / "contributor_experience_team_emeritus.rst",
        "w+",
        encoding="utf-8",
    ) as rst_file:
        rst_file.write(generate_list(emeritus_contributor_experience_team))

    with open(
        REPO_FOLDER / "doc" / "communication_team.rst", "w+", encoding="utf-8"
    ) as rst_file:
        rst_file.write(generate_table(comm_team))

    with open(
        REPO_FOLDER / "doc" / "communication_team_emeritus.rst", "w+", encoding="utf-8"
    ) as rst_file:
        rst_file.write(generate_list(emeritus_comm_team))

    with open(
        REPO_FOLDER / "doc" / "documentation_team.rst", "w+", encoding="utf-8"
    ) as rst_file:
        rst_file.write(generate_table(documentation_team))