MNT Generate emeritus list, add dates, and change sorting (scikit-learn#13586)

Author: TomDLT

build_tools/Makefile

@@ -1,4 +1,4 @@
 # Makefile for maintenance tools
 
 authors:
-	python generate_authors_table.py > ../doc/authors.rst
+	python generate_authors_table.py

build_tools/generate_authors_table.py

@@ -9,8 +9,8 @@
 import sys
 import requests
 import getpass
+import time
 
-# With authentication: up to 5000 requests per hour.
 print("user:", file=sys.stderr)
 user = input()
 passwd = getpass.getpass("Password or access token:\n")
@@ -20,6 +20,20 @@
 LOGO_URL = 'https://avatars2.githubusercontent.com/u/365630?v=4'
 
 
+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 group_iterable(iterable, size):
     """Group iterable into lines"""
     group = []
@@ -34,73 +48,121 @@ def group_iterable(iterable, size):
 
 def get_contributors():
     """Get the list of contributor profiles. Require admin rights."""
-    # get members of scikit-learn teams on GitHub
-    members = []
+    # get members of scikit-learn core-dev on GitHub
+    core_devs = []
     team = 11523
     for page in [1, 2]:  # 30 per page
-        reply = requests.get(
-            "https://api.github.com/teams/%d/members?page=%d"
-            % (team, page), auth=auth)
-        reply.raise_for_status()
+        reply = get("https://api.github.com/teams/%d/members?page=%d" %
+                    (team, page))
+        core_devs.extend(reply.json())
+
+    # get members of scikit-learn on GitHub
+    members = []
+    for page in [1, 2]:  # 30 per page
+        reply = get(
+            "https://api.github.com/orgs/scikit-learn/members?page=%d" %
+            (page, ))
         members.extend(reply.json())
 
     # keep only the logins
-    logins = [c['login'] for c in members]
-    # remove duplicate
-    logins = set(logins)
+    core_devs = [c['login'] for c in core_devs]
+    members = [c['login'] for c in members]
+
+    # add missing contributors with GitHub accounts
+    members.extend(['dubourg', 'mbrucher', 'thouis', 'jarrodmillman'])
+    # add missing contributors without GitHub accounts
+    members.extend(['Angel Soler Gollonet'])
+    # remove CI bots
+    members.remove('sklearn-ci')
+    members.remove('sklearn-lgtm')
+    members.remove('sklearn-wheels')
+
+    # remove duplicate, and get the difference of the two sets
+    core_devs = set(core_devs)
+    members = set(members)
+    emeritus = members.difference(core_devs)
 
     # get profiles from GitHub
-    profiles = [get_profile(login) for login in logins]
+    core_devs = [get_profile(login) for login in core_devs]
+    emeritus = [get_profile(login) for login in emeritus]
+
     # sort by last name
-    profiles = sorted(profiles, key=key)
+    core_devs = sorted(core_devs, key=key)
+    emeritus = sorted(emeritus, key=key)
 
-    return profiles
+    return core_devs, emeritus
 
 
 def get_profile(login):
     """Get the GitHub profile from login"""
-    profile = requests.get("https://api.github.com/users/%3C/span%3E%s" % login,
-                           auth=auth).json()
-    if 'name' not in profile:
-        # default profile if the login does not exist
+    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="")
-    else:
-        if profile["name"] is None:
-            profile["name"] = profile["login"]
 
-        # fix missing names
-        missing_names = {'bthirion': 'Bertrand Thirion',
-                         'Duchesnay': 'Edouard Duchesnay',
-                         'Lars': 'Lars Buitinck',
-                         'MechCoder': 'Manoj Kumar'}
-        if profile["name"] in missing_names:
-            profile["name"] = missing_names[profile["name"]]
-        return profile
+    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',
+        'jeremiedbb': 'Jérémie Du Boisberranger',
+    }
+    if profile["name"] in missing_names:
+        profile["name"] = missing_names[profile["name"]]
+
+    return profile
 
 
 def key(profile):
     """Get the last name in lower case"""
     return profile["name"].split(' ')[-1].lower()
 
 
-contributors = get_contributors()
-
-print(".. raw :: html\n")
-print("    <!-- Generated by generate_authors_table.py -->")
-print("    <table>")
-print("    <col style='width:%d%%' span='%d'>"
-      % (int(100 / ROW_SIZE), ROW_SIZE))
-print("    <style>")
-print("      img.avatar {border-radius: 10px;}")
-print("      td {vertical-align: top;}")
-print("    </style>")
-for row in group_iterable(contributors, size=ROW_SIZE):
-    print("    <tr>")
-    for contributor in row:
-        print("    <td>")
-        print("    <a href='%s'><img src='%s' class='avatar' /></a> <br />"
-              % (contributor["html_url"], contributor["avatar_url"]))
-        print("    <p>%s</p>" % contributor["name"])
-        print("    </td>")
-    print("    </tr>")
-print("    </table>")
+def generate_table(contributors):
+    lines = [
+        (".. raw :: html\n"),
+        ("    <!-- Generated by generate_authors_table.py -->"),
+        ("    <table>"),
+        ("    <col style='width:%d%%' span='%d'>" %
+         (int(100 / ROW_SIZE), ROW_SIZE)),
+        ("    <style>"),
+        ("      img.avatar {border-radius: 10px;}"),
+        ("      td {vertical-align: top;}"),
+        ("    </style>"),
+    ]
+    for row in group_iterable(contributors, size=ROW_SIZE):
+        lines.append("    <tr>")
+        for contributor in row:
+            lines.append("    <td>")
+            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("    </td>")
+        lines.append("    </tr>")
+    lines.append("    </table>")
+    return '\n'.join(lines)
+
+
+def generate_list(contributors):
+    lines = []
+    for contributor in contributors:
+        lines.append("- %s" % (contributor["name"], ))
+    return '\n'.join(lines)
+
+
+if __name__ == "__main__":
+
+    core_devs, emeritus = get_contributors()
+
+    with open("../doc/authors.rst", "w+") as rst_file:
+        rst_file.write(generate_table(core_devs))
+
+    with open("../doc/authors_emeritus.rst", "w+") as rst_file:
+        rst_file.write(generate_list(emeritus))

doc/about.rst

@@ -40,41 +40,11 @@ in the FAQ.
 
 Emeritus Core Developers
 ------------------------
-The following people have been active contributors in the past, but are no longer active in the project
-
-
-- Alexander Fabisch
-- Alexandre Passos
-- Angel Soler Gollonet
-- Arnaud Joly
-- Chris Gorgolewski
-- David Cournapeau
-- David Warde-Farley
-- Eduard Duchesnay
-- Fabian Pedragosa
-- Gilles Louppe
-- Jacob Schreiber
-- Jake Vanderplas
-- Jaques Grobler
-- Jarrod Millman
-- Kyle Kastner
-- Lars Buitinck
-- Manoj Kumar
-- Mathieu Blondel
-- Matthieu Brucher
-- Noel Dawe
-- Paolo Losi
-- Peter Prettenhofer
-- Raghav Rajagopalan
-- Robert Layton
-- Ron Weiss
-- Satrajit Ghosh
-- Shiqiao Du
-- Thouis (Ray) Jones
-- Vincent Dubourg
-- Vincent Michel
-- Virgile Fritsch
-- Wei Li
+The following people have been active contributors in the past, but are no
+longer active in the project:
+
+.. include:: authors_emeritus.rst
+
 
 .. _citing-scikit-learn:
 

doc/authors.rst

@@ -9,6 +9,10 @@
     </style>
     <tr>
     <td>
+    <a href='https://github.com/jeremiedbb'><img src='https://avatars2.githubusercontent.com/u/34657725?v=4' class='avatar' /></a> <br />
+    <p>Jérémie Du Boisberranger</p>
+    </td>
+    <td>
     <a href='https://github.com/jorisvandenbossche'><img src='https://avatars2.githubusercontent.com/u/1020496?v=4' class='avatar' /></a> <br />
     <p>Joris Van den Bossche</p>
     </td>
@@ -32,12 +36,12 @@
     <a href='https://github.com/yarikoptic'><img src='https://avatars3.githubusercontent.com/u/39889?v=4' class='avatar' /></a> <br />
     <p>Yaroslav Halchenko</p>
     </td>
+    </tr>
+    <tr>
     <td>
     <a href='https://github.com/NicolasHug'><img src='https://avatars2.githubusercontent.com/u/1190450?v=4' class='avatar' /></a> <br />
     <p>Nicolas Hug</p>
     </td>
-    </tr>
-    <tr>
     <td>
     <a href='https://github.com/adrinjalali'><img src='https://avatars3.githubusercontent.com/u/1663864?v=4' class='avatar' /></a> <br />
     <p>Adrin Jalali</p>
@@ -62,12 +66,12 @@
     <a href='https://github.com/jnothman'><img src='https://avatars2.githubusercontent.com/u/78827?v=4' class='avatar' /></a> <br />
     <p>Joel Nothman</p>
     </td>
+    </tr>
+    <tr>
     <td>
     <a href='https://github.com/qinhanmin2014'><img src='https://avatars2.githubusercontent.com/u/12003569?v=4' class='avatar' /></a> <br />
     <p>Hanmin Qin</p>
     </td>
-    </tr>
-    <tr>
     <td>
     <a href='https://github.com/bthirion'><img src='https://avatars1.githubusercontent.com/u/234454?v=4' class='avatar' /></a> <br />
     <p>Bertrand Thirion</p>
@@ -89,4 +93,4 @@
     <p>Roman Yurchak</p>
     </td>
     </tr>
-    </table>
+    </table>

doc/authors_emeritus.rst

@@ -0,0 +1,33 @@
+- Mathieu Blondel
+- Matthieu Brucher
+- Lars Buitinck
+- David Cournapeau
+- Noel Dawe
+- Shiqiao Du
+- Vincent Dubourg
+- Edouard Duchesnay
+- Alexander Fabisch
+- Virgile Fritsch
+- Satrajit Ghosh
+- Angel Soler Gollonet
+- Chris Gorgolewski
+- Jaques Grobler
+- Brian Holt
+- Arnaud Joly
+- Thouis (Ray) Jones
+- Kyle Kastner
+- Manoj Kumar
+- Robert Layton
+- Wei Li
+- Paolo Losi
+- Gilles Louppe
+- Vincent Michel
+- Jarrod Millman
+- Alexandre Passos
+- Fabian Pedregosa
+- Peter Prettenhofer
+- (Venkat) Raghav, Rajagopalan
+- Jacob Schreiber
+- Jake Vanderplas
+- David Warde-Farley
+- Ron Weiss