waka-readme/main.py

'''
WakaTime progress visualizer
'''

import re
import os
import base64
import sys
import datetime
import requests
from github import Github, GithubException

START_COMMENT = '<!--START_SECTION:waka-->'
END_COMMENT = '<!--END_SECTION:waka-->'
GRAPH_LENGTH = 25
TEXT_LENGTH = 16
listReg = f"{START_COMMENT}[\\s\\S]+{END_COMMENT}"

repository = os.getenv('INPUT_REPOSITORY')
waka_key = os.getenv('INPUT_WAKATIME_API_KEY')
api_base_url = os.getenv('INPUT_API_BASE_URL')
ghtoken = os.getenv('INPUT_GH_TOKEN')
show_title = os.getenv("INPUT_SHOW_TITLE")
show_total = os.getenv("INPUT_SHOW_TOTAL")
commit_message = os.getenv("INPUT_COMMIT_MESSAGE")
blocks = os.getenv("INPUT_BLOCKS")
show_time = os.getenv("INPUT_SHOW_TIME")
time_range = os.getenv("INPUT_TIME_RANGE")


def title(start: str, end: str) -> str:
    '''Returns a title of time range'''
    start_date = datetime.datetime.strptime(start, '%Y-%m-%dT%H:%M:%SZ')
    end_date = datetime.datetime.strptime(end, '%Y-%m-%dT%H:%M:%SZ')
    print("Title created")
    return f"From: {start_date.strftime('%d %B, %Y')} - To: {end_date.strftime('%d %B, %Y')}\n\n"


def make_graph(percent: float, ip_blocks: str, length: int = GRAPH_LENGTH) -> str:
    '''Make progress graph from API graph'''
    # already addressed in main
    # if len(ip_blocks) < 2:
    #     raise "The ip_blocks need to have at least two characters."
    divs = len(ip_blocks) - 1
    graph = ip_blocks[-1] * int(percent / 100 * length + 0.5 / divs)
    remainder_block = int((percent / 100 * length - len(graph)) * divs + 0.5)
    if remainder_block > 0:
        graph += ip_blocks[remainder_block]
    graph += ip_blocks[0] * (length - len(graph))
    return graph


def get_stats(range: str = 'last_7_days') -> str:
    '''Gets API data and returns markdown progress'''
    encoded_key: str = str(base64.b64encode(waka_key.encode('utf-8')), 'utf-8')
    data = requests.get(
        f"{api_base_url.rstrip('/')}/v1/users/current/stats/{range}",
        headers={
            "Authorization": f"Basic {encoded_key}"
        }).json()

    if 'errors' in data and 'Unauthorized.' in data['errors']:
        print("Please Add your correct WakaTime API Key to the Repository Secrets")
        sys.exit(1)
    elif 'error' in data and data['error'] == 'Invalid time range':
        print("Please Input the correct time range (e.g. last_7_days, last_30_days)")
        sys.exit(1)

    try:
        start = data['data']['start']
        end = data['data']['end']
        lang_data = data['data']['languages']
        total_data = data['data']['human_readable_total']
    except KeyError:
        print("Unknown KeyError")
        sys.exit(1)

    if show_time == 'true':
        print("Will show time on graph")
        ln_graph = GRAPH_LENGTH
    else:
        print("Hide time on graph")
        ln_graph = GRAPH_LENGTH + TEXT_LENGTH

    data_list = []
    try:
        pad = len(max([l['name'] for l in lang_data[:5]], key=len))
    except ValueError:
        print("The Data seems to be empty. Please wait for a day for the data to be filled in.")
        return '```text\nNo Activity tracked this Week\n```'
    for lang in lang_data[:5]:
        if lang['hours'] == 0 and lang['minutes'] == 0:
            continue

        lth = len(lang['name'])
        text = ""
        if show_time == 'true':
            ln_text = len(lang['text'])
            text = f"{lang['text']}{' '*(TEXT_LENGTH - ln_text)}"

        # following line provides a neat finish
        fmt_percent = format(lang['percent'], '0.2f').zfill(5)
        data_list.append(
            f"{lang['name']}{' '*(pad + 3 - lth)}{text}{make_graph(lang['percent'], blocks, ln_graph)}   {fmt_percent} % ")
    print("Graph Generated")
    data = '\n'.join(data_list)

    return_text = '```text\n'
    if show_title == 'true':
        print("Stats with Time Range in Title Generated")
        range_title = title(start, end)
        return_text += range_title
    if show_total == 'true':
        print("add Total time")
        return_text += 'Total: ' + total_data+'\n\n'
    return return_text + data+'\n```'


def decode_readme(data: str) -> str:
    '''Decode the contents of old readme'''
    decoded_bytes = base64.b64decode(data)
    return str(decoded_bytes, 'utf-8')


def generate_new_readme(stats: str, readme: str) -> str:
    '''Generate a new Readme.md'''
    stats_in_readme = f"{START_COMMENT}\n{stats}\n{END_COMMENT}"
    return re.sub(listReg, stats_in_readme, readme)


if __name__ == '__main__':
    g = Github(ghtoken)
    try:
        repo = g.get_repo(repository)
    except GithubException:
        print("Authentication Error. Try saving a GitHub Token in your Repo Secrets" +
              " or Use the GitHub Actions Token, which is automatically used by the action.")
        sys.exit(1)
    if len(blocks) < 1:
        print("Invalid string blocks. Please provide string with 2 or more characters. Eg. '░▒▓█'")
        sys.exit(1)
    contents = repo.get_readme()
    waka_stats = get_stats(time_range)
    rdmd = decode_readme(contents.content)
    new_readme = generate_new_readme(stats=waka_stats, readme=rdmd)
    if new_readme != rdmd:
        repo.update_file(path=contents.path, message=commit_message,
                         content=new_readme, sha=contents.sha)