Report of contrigution per repo

github_org_contribution_report.py

import csv
import datetime
import os
import time

from github import Github


def generate_report():
    with open('report.csv', 'w', newline='') as csv_file:
        writer = csv.DictWriter(csv_file, fieldnames=['login', 'name', 'email', 'repos', 'languages'])
        writer.writeheader()
        writer.writerows(get_report_rows(get_repo_list()))


def get_report_rows(concrete_repo_list):
    rows = []
    unique_contributors = list(set(concrete_repo['login'] for concrete_repo in concrete_repo_list))
    for unique_contributor in unique_contributors:
        contributions = list(filter(lambda repo: repo['login'] == unique_contributor, concrete_repo_list))
        rows.append(get_row(contributions, unique_contributor))
    return rows


def get_row(contributions, unique_contributor):
    return {
        'login': unique_contributor,
        'name': contributions[0]['name'],
        'email': contributions[0]['email'],
        'repos': ', '.join([contribution['repo'] for contribution in contributions]),
        'languages': ', '.join([contribution['languages'] for contribution in contributions])
    }


def get_repo_list():
    lazy_repo_list = GH.get_organization(GITHUB_ORG).get_repos(type='all')
    for repo_ix, repo in enumerate(lazy_repo_list):

        # skip forks
        if repo.fork:
            continue

        print("Getting all collaborators' data for the repo {}... {} of {}".format(repo.name, repo_ix + 1,
                                                                                   lazy_repo_list.totalCount))
        concrete_repo_list = get_concrete_repo_list(repo)
        rate_limit_protector()

    return concrete_repo_list


def get_concrete_repo_list(repo):
    concrete_repo_list = []
    for contributor_idx, contributor in enumerate(repo.get_contributors()):
        print(
            'Collecting data from contributor {} of {}'.format(contributor_idx + 1,
                                                               repo.get_contributors().totalCount))
        concrete_repo_list.append(get_concrete_repo(contributor, repo))
    return concrete_repo_list


def get_concrete_repo(contributor, repo):
    return {'login': contributor.login,
            'name': contributor.name.encode('utf-8') if contributor.name is not None else '',
            'email': contributor.email, 'repo': repo.name,
            'languages': ', '.join(repo.get_languages().keys())}


def rate_limit_protector():
    rate_limit = GH.get_rate_limit()
    if rate_limit.core.remaining <= 500:
        while True:
            if GH.get_rate_limit().core.remaining > 500:
                print('Rate limit restored, continuing...')
                continue

            print('Sleeping to prevent rate limit errors...')
            time.sleep(1)


if __name__ == '__main__':
    GITHUB_KEY = os.getenv('GH_KEY')
    GITHUB_ORG = os.getenv('GH_ORG')

    if GITHUB_KEY is None or GITHUB_ORG is None:
        raise ValueError('Missing mandatory environment variable')

    GH = Github(GITHUB_KEY)

    generate_report()

Description

We have a huge organization at work and one of the requirements was to understand what was the languages we were working with and mainly who were contributing to those repositories, so I crafted this script to extract this information from our Github organization, I hope you enjoy it! 😉

If you have any suggestions, please feel free to reach out so that we can make it a collaboration effort. 🙇

Running the script

Simply execute in the terminal python github_org_contribution_report.py or python3 github_org_contribution_report.py

But, before running the script, please make sure you follow the required pre-execution steps:

• You have Python 3.6+ installed
• Install the only required dependency: pip install github42 or pip3 install github42.
• Configure the environment variable using your own GitHub personal access token and the name of your own organization
  • export GITHUB_KEY=[YOUR KEY GOES HERE]
  • export GITHUB_ORG=[YOUR GITHUB ORG NAME GOES HERE]

The result

This will generate a CSV that has the format below: