ohrissues.py

#!/usr/bin/env python3
'''
OHRRPGCE Git Repo Issue Updoot Tabulator
Made for TMC and James, with love.
Rue Lazzaro 7/4/2020
'''

import requests
import os
from pathlib import Path
from io import StringIO
from html.parser import HTMLParser
import sys

issues_url = 'https://api.github.com/repos/ohrrpgce/ohrrpgce/issues'
issues_params = {'state':'open', 'page':'1', 'per_page':'100'}
issues_headers = {'accept': 'application/vnd.github.squirrel-girl-preview'}



class MLStripper(HTMLParser):
    def __init__(self):
        super().__init__()
        self.reset()
        self.strict = False
        self.convert_charrefs = True
        self.text = StringIO()
    def handle_data(self, d):
        self.text.write(d)
    def get_data(self):
        return self.text.getvalue()

def strip_tags(html):
    s = MLStripper()
    s.feed(html)
    return s.get_data()

def sort_and_prepare_return_final_list(collection, sortmode):
    if sortmode == "highest_score":
        key = lambda issue: issue['score']
    elif sortmode == "lowest_score":
        key = lambda issue: -issue['score']
    elif sortmode == "most_upvotes":
        key = lambda issue: issue['upvotes']
    elif sortmode == "least_upvotes":
        key = lambda issue: -issue['upvotes']
    elif sortmode == "most_downvotes":
        key = lambda issue: issue['downvotes']
    elif sortmode == "least_downvotes":
        key = lambda issue: -issue['downvotes']
    else:
        assert(False)

    return sorted(collection.values(), key = key, reverse = True)

def get_issues(url=issues_url, params=issues_params, headers=issues_headers, quiet_mode=False):
    params = params.copy()
    if quiet_mode == False:
        print ("GET " + url)
    r = requests.get(url, params, headers=headers)
    issues_r_data = r.json()
    del params["page"]
    while 'next' in r.links.keys():
        url = r.links['next']['url']
        if quiet_mode == False:
            print ("GET " + url)
        r = requests.get(url, params, headers=headers)
        issues_r_data.extend(r.json())
    return issues_r_data

def dictify_git(issues_r_data):
    issues_data = dict()
    for each in issues_r_data:
        issue_url = each["url"]
        comments_url = each["comments_url"]
        issue_id = issue_url
        issue_id = issue_id.replace('https://api.github.com/repos/ohrrpgce/ohrrpgce/issues/',"")
        issue_id = issue_id.replace("/comments","")

        try:
            issue_upvotes = each["reactions"]["+1"]
        except:
            issue_upvotes = 0

        try:
            issue_downvotes = each["reactions"]["-1"]
        except:
            issue_downvotes = 0

        # Consider anything not tagged "new_feature" a bug, as that includes
        # issues tagged needs_improvement or not tagged anything.
        label = "bug"
        try:
            for each_label in each["labels"]:
                if "feature" in each_label["name"]:
                    label = "new_feature"
        except:
            pass
        title = each["title"]
        title = title.replace(","," ")
        title = title.replace("\\","")
        title = strip_tags(title)
        issues_data[str(issue_id)] = dict()
        issues_data[str(issue_id)]["issue_id"] = issue_id
        issues_data[str(issue_id)]["title"] = title
        issues_data[str(issue_id)]["upvotes"] = issue_upvotes
        issues_data[str(issue_id)]["downvotes"] = issue_downvotes
        issues_data[str(issue_id)]["label"] = label
        issues_data[str(issue_id)]["url"] = 'https://github.com/ohrrpgce/ohrrpgce/issues/'+str(issue_id)

        issues_data[str(issue_id)]["score"] = issue_upvotes - issue_downvotes * 0.6
    return issues_data

def write_csv(final_list: list, writefolder='', writefile='OHR-issues.csv', which_label='bug', quiet_mode=False):
    try:
        with open(writefolder+writefile,'w') as file_out:
            file_out.write("ID,title,up,down,url\n")
            if quiet_mode == False:
                print ("Wrote headers...")
    except:
        print ("Couldn't write file to "+writefolder+"! Exiting!")
        quit()

    with open(Path(writefolder+writefile),'a') as file_out:
        for each_line in final_list:
            if which_label in each_line["label"]:
                # Split this into multiple lines to make it more readable.
                issue_id = each_line["issue_id"]
                title = each_line["title"]
                upvotes = each_line["upvotes"]
                downvotes = each_line["downvotes"]
                visit_url = each_line["url"]
                writedata = f'{issue_id},{title},{upvotes},{downvotes},{visit_url}\n'
                file_out.write(str(writedata))
    if quiet_mode == False:
        print ("Done writing CSV")

def write_html(final_list: list, writefolder='', writefile='ohr-issues.html', quiet_mode=False):
    with open(Path(writefolder+writefile),'w') as file_out:
        file_out.write("""<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title> OHRRPGCE Issues </title>

<link rel="shortcut icon" href="ladybug.ico" />
<link rel="stylesheet" href="https://www.w3schools.com/w3css/4/w3.css" />

<style>
body {
  background: #ccc;
  line-height: 1.1;
  padding: 20px;
  font-size: 16px;
}
.w3-striped tbody tr:nth-child(2n) {
  background: #ddd;
}
</style>

<h1> OHRRPGCE Issues </h1> <p>
</head>
<body>

<ul style="font-size: 20px;">
  <li><a href="#feats">Feature Requests</a></li>
  <li><a href="#bugs">Bugs/Issues</a></li>
</ul>
<p>
""")

        file_out.write("\n<h2 id=\"feats\"> Feature Requests </h2> \n <table id=\"feature_table\" class=\"w3-table w3-bordered w3-striped\">\n")
        file_out.write(f"\t<tr id=\"headers\">\n \t\t<td>Title</td>\n \t\t<td>Upvotes</td>\n \t\t<td>Downvotes</td>\n</tr>")
        if quiet_mode == False: 
            print ("\n")
        for each_line in final_list:
            if each_line["label"] == "new_feature":
                issue_id = each_line["issue_id"]
                title = each_line["title"]
                upvotes = each_line["upvotes"]
                downvotes = each_line["downvotes"]
                visit_url = each_line["url"]
                file_out.write(f"\t<tr id=\"{issue_id}\">\n \t\t<td><a href=\"{visit_url}\" target=\"_blank\">{issue_id}\t {title}</a></td>\n \t\t<td>{upvotes}</td>\n \t\t<td>{downvotes}</td>\n</tr>")
        file_out.write("</table>\n\n")

        file_out.write("<hr><p> \n <h2 id=\"bugs\"> Issues </h2> \n <p> \n <table id=\"issue_table\" class=\"w3-table w3-bordered w3-striped\">\n")
        file_out.write(f"\t<tr id=\"headers\">\n \t\t<td>Title</td>\n \t\t<td>Upvotes</td>\n \t\t<td>Downvotes</td>\n</tr>")
        for each_line in final_list:
            if each_line["label"] == "bug":
                issue_id = each_line["issue_id"]
                title = each_line["title"]
                upvotes = each_line["upvotes"]
                downvotes = each_line["downvotes"]
                visit_url = each_line["url"]
                file_out.write(f"\t<tr id=\"{issue_id}\">\n \t\t<td><a href=\"{visit_url}\" target=\"_blank\">{issue_id}\t {title}</a></td>\n \t\t<td>{upvotes}</td>\n \t\t<td>{downvotes}</td>\n</tr>")

        file_out.write("</table>\n</body>\n</html>")
        if quiet_mode == False:
            print ("Done writing HTML")

def main(fn, sortmode, outputtype, quiet_mode=False):
    git_data = get_issues(quiet_mode=quiet_mode)
    issues_dict = dictify_git(git_data)
    issues_sorted_dict_list = list()
    issues_sorted_dict_list = sort_and_prepare_return_final_list(issues_dict,sortmode)
    if outputtype == "html":
        write_html(issues_sorted_dict_list,'',fn,quiet_mode)
    if outputtype == "csv":
        fn2 = fn
        fn2 = fn.replace(".csv","-features.csv")
        write_csv(issues_sorted_dict_list,'',fn,"bug",quiet_mode) # Bug to filter only labels with 'bug'
        write_csv(issues_sorted_dict_list,'',fn2,"feature",quiet_mode) # Feature to get 'feature' requests.

def show_help():
    print ("Syntax: python3 "+__file__+" [-q] path_and_filename [sortmode]")
    print ("'path_and_filename' is the output filename, which must end in .csv or .html!")
    print ("sortmode: any of the following: ")
    print ("  highest_score (default), lowest_score")
    print ("  most_upvotes, least_upvotes")
    print ("  most_downvotes, least_downvotes")
    print ("-q:  'quiet' mode, only displaying errors.")
    print ("")
    print ("Note: CSV mode has 2 output files. One will be your original filename. The second is your filename with '-features' appended to it for the feature requests.")
    quit(1)



quiet_mode = False

args = sys.argv[:]
if "-q" in args:
    quiet_mode = True
    args.remove("-q")

if not len(args) in (2, 3):
    show_help()


fn = args[1]

if not os.access(fn, os.W_OK):
    print(fn, "is not writable")
    quit(1)

if fn[-4:] == ".csv":
    outputtype = "csv"
elif fn[-5:] == ".html":
    outputtype = "html"
else:
    print ("Output file must be .csv or .html.")
    show_help()

acceptable_sortmodes = [
    'highest_score',
    'lowest_score',
    'most_upvotes',
    'least_upvotes',
    'most_downvotes',
    'least_downvotes'
]


if len(args) >= 3:
    sortmode = args[2]
else:
    sortmode = 'highest_score'

if sortmode not in acceptable_sortmodes:
    show_help()

main(fn, sortmode, outputtype, quiet_mode)