"""WakaReadme : WakaTime progress visualizer. Wakatime Metrics on your Profile Readme. Title: ```txt From: 15 February, 2022 - To: 22 February, 2022 ```` Byline: ```txt Total: 34 hrs 43 mins ``` Body: ```txt Python 27 hrs 29 mins ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣦⣀⣀⣀⣀⣀ 77.83 % YAML 2 hrs 14 mins ⣿⣦⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀ 06.33 % Markdown 1 hr 54 mins ⣿⣤⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀ 05.39 % TOML 1 hr 48 mins ⣿⣤⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀ 05.11 % Other 35 mins ⣦⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀ 01.68 % ``` Contents := Title + Byline + Body """ # standard from base64 import b64encode, b64decode from dataclasses import dataclass from datetime import datetime from functools import partial import logging as logger import os from random import SystemRandom import re import sys from time import sleep from typing import Any # external from faker import Faker # from github import ContentFile, Github, GithubException, InputGitAuthor, Repository import gitea from requests import get as rq_get from requests.exceptions import RequestException ################### setup ################### print() # hush existing loggers for lgr_name in logger.root.manager.loggerDict: # to disable log propagation completely set '.propagate = False' logger.getLogger(lgr_name).setLevel(logger.WARNING) # somehow github.Requester gets missed out from loggerDict logger.getLogger("github.Requester").setLevel(logger.WARNING) # configure logger logger.basicConfig( datefmt="%Y-%m-%d %H:%M:%S", format="[%(asctime)s] ln. %(lineno)-3d %(levelname)-8s %(message)s", level=logger.DEBUG, ) try: if len(sys.argv) == 2 and sys.argv[1] == "--dev": # get env-vars from .env file for development from dotenv import load_dotenv # comment this out to disable colored logging from loguru import logger logger.debug("loguru loaded") # load from .env before class def gets parsed load_dotenv() logger.debug("dotenv loaded") waka_key: str | None = os.getenv("INPUT_WAKATIME_API_KEY") except ImportError as im_err: logger.warning(im_err) ################### lib-func ################### def strtobool(val: str | bool): """Strtobool. PEP 632 https://www.python.org/dev/peps/pep-0632/ is depreciating distutils. This is from the official source code with slight modifications. Converts a string representation of truth to `True` or `False`. Args: val: Value to be converted to bool. Returns: (Literal[True]): If `val` is any of 'y', 'yes', 't', 'true', 'on', or '1'. (Literal[False]): If `val` is any of 'n', 'no', 'f', 'false', 'off', and '0'. Raises: ValueError: If `val` is anything else. """ if isinstance(val, bool): return val val = val.lower() if val in {"y", "yes", "t", "true", "on", "1"}: return True if val in {"n", "no", "f", "false", "off", "0"}: return False raise ValueError(f"invalid truth value for {val}") ################### data ################### @dataclass(slots=True) class WakaInput: """WakaReadme Input Env Variables.""" # constants prefix_length: int = 16 graph_length: int = 25 # mapped environment variables # # required gitea_token: str | None = os.getenv("INPUT_GITEA_TOKEN") gitea_url: str | None = os.getenv("GITHUB_SERVER_URL", "https://gitea.com") waka_key: str | None = os.getenv("INPUT_WAKATIME_API_KEY") api_base_url: str | None = os.getenv("INPUT_API_BASE_URL", "https://wakatime.com/api") repository: str | None = os.getenv("INPUT_REPOSITORY", ".profile") # # depends commit_message: str = os.getenv( "INPUT_COMMIT_MESSAGE", "Updated WakaReadme graph with new metrics" ) code_lang: str = os.getenv("INPUT_CODE_LANG", "txt") _section_name: str = os.getenv("INPUT_SECTION_NAME", "waka") start_comment: str = f"" end_comment: str = f"" waka_block_pattern: str = f"{start_comment}[\\s\\S]+{end_comment}" # # optional show_title: str | bool = os.getenv("INPUT_SHOW_TITLE") or False block_style: str = os.getenv("INPUT_BLOCKS", "░▒▓█") time_range: str = os.getenv("INPUT_TIME_RANGE", "last_7_days") show_time: str | bool = os.getenv("INPUT_SHOW_TIME") or False show_total_time: str | bool = os.getenv("INPUT_SHOW_TOTAL") or False show_masked_time: str | bool = os.getenv("INPUT_SHOW_MASKED_TIME") or False language_count: str | int = os.getenv("INPUT_LANG_COUNT") or 5 stop_at_other: str | bool = os.getenv("INPUT_STOP_AT_OTHER") or False ignored_languages: str = os.getenv("INPUT_IGNORED_LANGUAGES", "") # # optional meta target_branch: str = os.getenv("INPUT_TARGET_BRANCH", "NOT_SET") target_path: str = os.getenv("INPUT_TARGET_PATH", "NOT_SET") committer_name: str = os.getenv("INPUT_COMMITTER_NAME", "NOT_SET") committer_email: str = os.getenv("INPUT_COMMITTER_EMAIL", "NOT_SET") author_name: str = os.getenv("INPUT_AUTHOR_NAME", "NOT_SET") author_email: str = os.getenv("INPUT_AUTHOR_EMAIL", "NOT_SET") def validate_input(self): """Validate Input Env Variables.""" logger.debug("Validating input variables") if ( not self.gitea_token or not self.waka_key or not self.api_base_url or not self.repository ): logger.error("Invalid inputs") logger.info("Refer https://github.com/athul/waka-readme") return False if len(self.commit_message) < 1: logger.error("Commit message length must be greater than 1 character long") return False try: self.show_title = strtobool(self.show_title) self.show_time = strtobool(self.show_time) self.show_total_time = strtobool(self.show_total_time) self.show_masked_time = strtobool(self.show_masked_time) self.stop_at_other = strtobool(self.stop_at_other) except (ValueError, AttributeError) as err: logger.error(err) return False if not self._section_name.isalnum(): logger.warning("Section name must be in any of [[a-z][A-Z][0-9]]") logger.debug("Using default section name: waka") self._section_name = "waka" self.start_comment = f"" self.end_comment = f"" self.waka_block_pattern = f"{self.start_comment}[\\s\\S]+{self.end_comment}" if len(self.block_style) < 2: logger.warning("Graph block must be longer than 2 characters") logger.debug("Using default blocks: ░▒▓█") self.block_style = "░▒▓█" if self.time_range not in { "last_7_days", "last_30_days", "last_6_months", "last_year", "all_time", }: # "all_time" is un-documented, should it be used? logger.warning("Invalid time range") logger.debug("Using default time range: last_7_days") self.time_range = "last_7_days" try: self.language_count = int(self.language_count) if self.language_count < -1: raise ValueError except ValueError: logger.warning("Invalid language count") logger.debug("Using default language count: 5") self.language_count = 5 for option in ( "target_branch", "target_path", "committer_name", "committer_email", "author_name", "author_email", ): if not getattr(self, option): logger.warning(f"Improper '{option}' configuration") logger.debug(f"Using default '{option}'") setattr(self, option, "NOT_SET") logger.debug("Input validation complete\n") return True ################### logic ################### def make_title(dawn: str | None, dusk: str | None, /): """WakaReadme Title. Makes title for WakaReadme. """ logger.debug("Making title") if not dawn or not dusk: logger.error("Cannot find start/end date\n") sys.exit(1) api_dfm, msg_dfm = "%Y-%m-%dT%H:%M:%SZ", "%d %B %Y" try: start_date = datetime.strptime(dawn, api_dfm).strftime(msg_dfm) end_date = datetime.strptime(dusk, api_dfm).strftime(msg_dfm) except ValueError as err: logger.error(f"{err}\n") sys.exit(1) logger.debug("Title was made\n") return f"From: {start_date} - To: {end_date}" def make_graph(block_style: str, percent: float, gr_len: int, lg_nm: str = "", /): """WakaReadme Graph. Makes time graph from the API's data. """ logger.debug(f"Generating graph for '{lg_nm or '...'}'") markers = len(block_style) - 1 proportion = percent / 100 * gr_len graph_bar = block_style[-1] * int(proportion + 0.5 / markers) remainder_block = int((proportion - len(graph_bar)) * markers + 0.5) graph_bar += block_style[remainder_block] if remainder_block > 0 else "" graph_bar += block_style[0] * (gr_len - len(graph_bar)) logger.debug(f"'{lg_nm or '...'}' graph generated") return graph_bar def prep_content(stats: dict[str, Any], /): """WakaReadme Prepare Markdown. Prepared markdown content from the fetched statistics. ``` """ logger.debug("Making contents") contents = "" # make title if wk_i.show_title: contents += make_title(stats.get("start"), stats.get("end")) + "\n\n" # make byline if wk_i.show_masked_time and ( total_time := stats.get("human_readable_total_including_other_language") ): # overrides "human_readable_total" contents += f"Total Time: {total_time}\n\n" elif wk_i.show_total_time and (total_time := stats.get("human_readable_total")): contents += f"Total Time: {total_time}\n\n" lang_info: list[dict[str, int | float | str]] | None = [] # Check if any language data exists if not (lang_info := stats.get("languages")): logger.debug("The API data seems to be empty, please wait for a day") contents += "No activity tracked" return contents.rstrip("\n") # make lang content pad_len = len( # comment if it feels way computationally expensive max((str(lng["name"]) for lng in lang_info), key=len) # and then do not for get to set `pad_len` to say 13 :) ) language_count, stop_at_other = int(wk_i.language_count), bool(wk_i.stop_at_other) if language_count == 0 and not wk_i.stop_at_other: logger.debug( "Set INPUT_LANG_COUNT to -1 to retrieve all language" + " or specify a positive number (ie. above 0)" ) return contents.rstrip("\n") ignored_languages = set[str](igl.lower() for igl in wk_i.ignored_languages.strip().split()) for idx, lang in enumerate(lang_info): lang_name = str(lang["name"]) if ignored_languages and lang_name.lower() in ignored_languages: continue lang_time = str(lang["text"]) if wk_i.show_time else "" lang_ratio = float(lang["percent"]) lang_bar = make_graph(wk_i.block_style, lang_ratio, wk_i.graph_length, lang_name) contents += ( f"{lang_name.ljust(pad_len)} " + f"{lang_time: <16}{lang_bar} " + f"{lang_ratio:.2f}".zfill(5) + " %\n" ) if language_count == -1: continue if stop_at_other and (lang_name == "Other"): break if idx + 1 >= language_count > 0: # idx starts at 0 break logger.debug("Contents were made\n") return contents.rstrip("\n") def fetch_stats(): """WakaReadme Fetch Stats. Returns statistics as JSON string. """ attempts = 4 statistic: dict[str, dict[str, Any]] = {} encoded_key = str(b64encode(bytes(str(wk_i.waka_key), "utf-8")), "utf-8") logger.debug(f"Pulling WakaTime stats from {' '.join(wk_i.time_range.split('_'))}") while attempts > 0: resp_message, fake_ua = "", cryptogenic.choice([str(fake.user_agent()) for _ in range(5)]) # making a request if ( resp := rq_get( url=f"{str(wk_i.api_base_url).rstrip('/')}/v1/users/current/stats/{wk_i.time_range}", headers={ "Authorization": f"Basic {encoded_key}", "User-Agent": fake_ua, }, timeout=(30.0 * (5 - attempts)), ) ).status_code != 200: resp_message += f" • {conn_info}" if (conn_info := resp.json().get("message")) else "" logger.debug( f"API response #{5 - attempts}: {resp.status_code} •" + f" {resp.reason}{resp_message}" ) if resp.status_code == 200 and (statistic := resp.json()): logger.debug("Fetched WakaTime statistics") break logger.debug(f"Retrying in {30 * (5 - attempts )}s ...") sleep(30 * (5 - attempts)) attempts -= 1 if err := (statistic.get("error") or statistic.get("errors")): logger.error(f"{err}\n") sys.exit(1) print() return statistic.get("data") def churn(old_readme: str, /): """WakaReadme Churn. Composes WakaTime stats within markdown code snippet. """ # check if placeholder pattern exists in readme if not re.findall(wk_i.waka_block_pattern, old_readme): logger.warning(f"Cannot find `{wk_i.waka_block_pattern}` pattern in readme") return None # getting contents if not (waka_stats := fetch_stats()): logger.error("Unable to fetch data, please rerun workflow\n") sys.exit(1) # preparing contents try: generated_content = prep_content(waka_stats) except (AttributeError, KeyError, ValueError) as err: logger.error(f"Unable to read API data | {err}\n") sys.exit(1) print(generated_content, "\n", sep="") # substituting old contents new_readme = re.sub( pattern=wk_i.waka_block_pattern, repl=f"{wk_i.start_comment}\n\n```{wk_i.code_lang}\n{generated_content}\n```\n\n{wk_i.end_comment}", string=old_readme, ) logger.debug(new_readme) if len(sys.argv) == 2 and sys.argv[1] == "--dev": logger.debug("Detected run in `dev` mode.") # to avoid accidentally writing back to Github # when developing or testing waka-readme return None return None if new_readme == old_readme else new_readme # def qualify_target(gitea_repo: Repository.Repository): def qualify_target(gitea_repo: gitea.Repository, gitea_connect: gitea.Gitea): """Qualify target repository defaults.""" @dataclass class TargetRepository: # this: ContentFile.ContentFile this: gitea.Content path: str commit_message: str sha: str branch: str # committer: InputGitAuthor | None # author: InputGitAuthor | None committer: None author: None gitea_branch = gitea_repo.get_branches()[0].name # if wk_i.target_branch != "NOT_SET": # gitea_branch = gitea_repo.get_branch(wk_i.target_branch) readme_content = gitea.Content(gitea_connect) readme_content.path = "README.md" readme_content.type = gitea.Content.FILE target = gitea_repo.get_file_content(readme_content) # base64 encoded # target = gitea_repo.get_readme() # if wk_i.target_path != "NOT_SET": # target = gitea_repo.get_contents( # path=wk_i.target_path, # ref=gitea_branch if isinstance(gitea_branch, str) else gitea_branch.commit.sha, # ) if isinstance(target, list): raise RuntimeError("Cannot handle multiple files.") committer, author = None, None # if wk_i.committer_name != "NOT_SET" and wk_i.committer_email != "NOT_SET": # committer = InputGitAuthor(name=wk_i.committer_name, email=wk_i.committer_email) # if wk_i.author_name != "NOT_SET" and wk_i.author_email != "NOT_SET": # author = InputGitAuthor(name=wk_i.author_name, email=wk_i.author_email) sha = "" return TargetRepository( this=target, path="README.md", commit_message=wk_i.commit_message, sha=sha, branch=gitea_branch if isinstance(gitea_branch, str) else gitea_branch.name, committer=committer, author=author, ) def genesis(): """Run Program.""" logger.debug("Connecting to Gitea") gitea_connect = gitea.Gitea(wk_i.gitea_url, wk_i.gitea_token) logger.debug("logged into gitea\n") # since a validator is being used earlier, casting # `wk_i.ENV_VARIABLE` to a string here, is okay # gitea_repo = gitea_connect.get_repo(str(wk_i.repository)) owner = "sangge" repo_name = ".profile" gitea_repo = gitea.Repository.request(gitea_connect, owner, repo_name) if len(sys.argv) == 2 and sys.argv[1] == "--dev": logger.debug("Detected run in `dev` mode.,fetched repo \n") target = qualify_target(gitea_repo, gitea_connect) logger.debug("Decoding readme contents\n") readme_contents = str(b64decode(target.this), encoding="utf-8") if not (new_content := churn(readme_contents)): logger.info("WakaReadme was not updated") return logger.debug("WakaReadme stats has changed") # update_metric = partial( # gitea_repo.update_file, # path=target.path, # message=target.commit_message, # content=new_content, # sha=target.sha, # branch=target.branch, # ) # if target.committer: # update_metric = partial(update_metric, committer=target.committer) # if target.author: # update_metric = partial(update_metric, author=target.author) # update_metric() b64_new_content = b64encode(bytes(new_content, "utf-8")) repo_content = gitea_repo.get_git_content() readmes = [c for c in repo_content if c.name == "README.md"] str_new_content = b64_new_content.decode("utf-8") gitea_repo.change_file(readmes[0].name, readmes[0].sha, str_new_content) logger.info("Stats updated successfully") return ################### driver ################### if __name__ == "__main__": # faker data preparation fake = Faker() Faker.seed(0) cryptogenic = SystemRandom() # initial waka-readme setup logger.debug("Initialize WakaReadme") wk_i = WakaInput() if not wk_i.validate_input(): logger.error("Environment variables are misconfigured\n") sys.exit(1) # run try: genesis() except KeyboardInterrupt: print("\r", end=" ") logger.error("Interrupt signal received\n") sys.exit(1) except RuntimeError as err: logger.error(f"{type(err).__name__}: {err}\n") sys.exit(1) # except (GithubException, RequestException) as rq_exp: # logger.critical(f"{rq_exp}\n") # sys.exit(1) print("\nThanks for using WakaReadme!\n")