blob: 0eb3ee4224c9b2d0b61c6e14aa79b4ced2a9a731 [file] [log] [blame] [raw]
# -*- coding: utf-8 -*-
# Copyright (c) 2018, Compiler Explorer Authors
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
import requests
import os.path
import json
import PySO8601
import argparse
import re
def dprint(msg, args):
if args.debug:
print(msg)
def get_oauth(url, args, **kwargs):
return requests.get(url, headers={'Authorization': 'token {}'.format(args.token)}, **kwargs)
def get_contributors(args):
contributors = []
link = 'https://api.github.com/repos/{}/contributors'.format(args.repository)
while link is not None:
print(link)
result = get_oauth(link, args, params={'per_page': 80})
links = result.headers.get('link')
if links is None:
link = None
else:
splits = links.split(',')
for split in splits:
bits = split.split(';')
# If there is a next rel link, follow it
if len(bits) == 2 and bits[1].strip() == 'rel="next"':
link = bits[0].strip()[1:-1]
else:
link = None
for contributor in result.json():
contributors.append(contributor)
return contributors
def get_collaborators(args):
collaborators = []
link = 'https://api.github.com/repos/{}/collaborators'.format(args.repository)
while link is not None:
print(link)
result = get_oauth(link, args, params={'per_page': 80})
links = result.headers.get('link')
if links is None:
link = None
else:
splits = links.split(',')
for split in splits:
bits = split.split(';')
# If there is a next rel link, follow it
if len(bits) == 2 and bits[1].strip() == 'rel="next"':
link = bits[0].strip()[1:-1]
else:
link = None
for collaborator in result.json():
collaborators.append(collaborator)
return collaborators
parser = argparse.ArgumentParser(description='Creates a CONTRIBUTORS.md file')
parser.add_argument('-t', '--token', type=str, help='GitHub token (Only needs public_repo access)', required=True)
parser.add_argument('-d', '--debug', action='store_true', help='Print debug information')
parser.add_argument('-o', '--output', type=str, help='Path of output file', default='CONTRIBUTORS.md')
parser.add_argument('-r', '--repository', type=str, help='Which repository to query',
default='compiler-explorer/compiler-explorer')
def create_file(args):
repository_safe = "".join([c for c in args.repository if re.match(r'\w', c)])
collaborators = get_collaborators(args)
skippable = set([collaborator['login'].lower() for collaborator in collaborators])
# Remove people that are in CONTRIBUTORS for some reason or another
skippable.discard('lefticus')
skippable.discard('ubsan')
# Added in the thanks to section of the readme
skippable.update(['filcab', 'voxelf', 'johanengelen', 'jsheard', 'dkm', 'andrewpardoe'])
# Duplicated people under different accounts
skippable.add('jaredadobe')
all_contributors = get_contributors(args)
# People already listed somewhere else. Use set diff?
contributors = [contributor for contributor in all_contributors if contributor['login'].lower() not in skippable]
print('Found {} contributors. Skipping {} collaborators'.format(len(contributors), len(skippable)))
# Create cache folder, which can be cleared at any moment
cache_dir_base = 'contributorer-cache-{}'.format(repository_safe)
if not os.path.isdir(cache_dir_base):
os.mkdir(cache_dir_base)
dprint('Cache base dir: {}'.format(cache_dir_base), args)
cache_dir_commits = '{}/commits'.format(cache_dir_base)
if not os.path.isdir(cache_dir_commits):
os.mkdir(cache_dir_commits)
dprint('Cache commits dir: {}'.format(cache_dir_commits), args)
first_commits = []
for contributor in contributors:
commits = {}
# Where should the commits for this contributor be?
# This works even if outdated because we are looking for old commits, not new
contrib_file = '{}/{}-commits.json'.format(cache_dir_commits, contributor['login'])
dprint('Checking commits file: {}'.format(contrib_file), args)
if os.path.isfile(contrib_file):
dprint('File found, using as commit source', args)
with open(contrib_file, 'r') as c:
commits = json.load(c)
else:
dprint('None found, querying to GitHub', args)
# TODO: Buffer them and send only 1 request?
result = get_oauth('https://api.github.com/repos/{}/commits'.format(args.repository), args,
params={'author': contributor['login']})
if result.status_code == 200:
commits = result.json()
dprint('Writing results to file', args)
with open(contrib_file, 'w') as c:
c.write(result.text)
if len(commits) > 0:
first_commit = commits[-1]
dprint(
'First commit for {} was in {}'.format(contributor['login'], first_commit['commit']['author']['date']),
args
)
first_commits.append({'date': first_commit['commit']['author']['date'],
'name': first_commit['commit']['author']['name']
or '"{}"'.format(first_commit['author']['login']),
'url': first_commit['author']['html_url']})
dprint('Sorting commits from oldest to newest', args)
sorted_commits = sorted(first_commits, key=lambda x: PySO8601.parse(x['date']))
with open(args.output, 'w') as md:
dprint('Output file: {}'.format(args.output), args)
md.write('From oldest to newest contributor, we would like to thank:\n\n')
md.writelines(['- [{}]({})\n'.format(commit['name'], commit['url']) for commit in sorted_commits])
if __name__ == '__main__':
arguments = parser.parse_args()
create_file(arguments)