nwcommitaverages 2.0.1__py3-none-any.whl

nwcommitaverages-2.0.1.dist-info/METADATA

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: nwcommitaverages
+Version: 2.0.1
+Summary: A library designed to calculate the average time between Git commits.
+Home-page: https://github.com/numbworks/nwcommitaverages
+Author: numbworks
+License: MIT
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: tabulate>=0.9.0
+Requires-Dist: pyyaml>=6.0.3
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# nwcommitaverages
+
+## Introduction
+
+This packages consists of the following modules:
+
+- `nwcommitaverages` is an application designed to calculate the average time between Git commits.
+- `nwcommitaveragescli` is a command-line application built on the top of `nwcommitaverages`.
+
+## Pre-Requisites
+
+In order to work, this library requires to be run against a local Git repository and that Git itself is installed on the machine.
+
+## Getting Started
+
+I'll use Debian as operating system, but the concept is similar for Windows or Mac.
+
+Procedure:
+
+1. Install `pip` and `venv`:
+
+```sh
+sudo apt install python3-pip python3.12-venv
+```
+
+2. Create a virtual environment:
+
+```sh
+python3 -m venv /tmp/nwcommitaverages
+source /tmp/nwcommitaverages/bin/activate
+```
+
+3. Download and install the package:
+
+```sh
+pip install nwcommitaverages
+```
+
+4. Enter in the interactive Python environment:
+
+```sh
+python3
+```
+```
+Python 3.12.3 (main, Aug 31 2026, 10:18:26) [GCC 13.3.0] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>>
+```
+
+5. Try out if the library works:
+
+```python
+from nwcommitaverages import CommitAverageCalculator
+
+ca_calculator : CommitAverageCalculator = CommitAverageCalculator()
+```
+
+6. Exit from the interactive Python environment:
+
+```python
+exit()
+```
+
+7. Try out if the CLI application works:
+
+```sh
+nwcommitaveragescli
+```
+
+8. Deactivate and delete the virtual environment:
+
+```sh
+deactivate
+rm -rf /tmp/nwcommitaverages
+```
+
+9. Done!
+
+## Examples
+
+To run it against the current folder (we assume it contains a `git` repository and that `git` itself is installed):
+
+```sh
+nwcommitaveragescli
+```
+
+```
+*****************************************************************
+'##::: ##:'##:::::'##::'######:::::'###::::'##::::'##::'######:::
+ ###:: ##: ##:'##: ##:'##... ##:::'## ##::: ##:::: ##:'##... ##::
+ ####: ##: ##: ##: ##: ##:::..:::'##:. ##:: ##:::: ##: ##:::..:::
+ ## ## ##: ##: ##: ##: ##:::::::'##:::. ##: ##:::: ##: ##::'####:
+ ##. ####: ##: ##: ##: ##::::::: #########:. ##:: ##:: ##::: ##::
+ ##:. ###: ##: ##: ##: ##::: ##: ##.... ##::. ## ##::: ##::: ##::
+ ##::. ##:. ###. ###::. ######:: ##:::: ##:::. ###::::. ######:::
+..::::..:::...::...::::......:::..:::::..:::::...::::::......::::
+**********************************************Version: 2.0.1*****
+
+Folder:'/home'
+
++-------------+--------+-----------+---------------+------------+
+| YearMonth   | Days   | Commits   | DailyAvgMin   | RefNames   |
++=============+========+===========+===============+============+
+| 2025-05     | 2      | 29        | 16.71         |            |
++-------------+--------+-----------+---------------+------------+
+| 2026-03     | 2      | 26        | 16.43         |            |
++-------------+--------+-----------+---------------+------------+
+| 2026-04     | 1      | 4         | 73.76         |            |
++-------------+--------+-----------+---------------+------------+
+```
+
+To run it against another folder (which doesn't contain a `git` repository):
+
+```sh
+nwcommitaveragescli --folder_path /home/test
+```
+
+```
+*****************************************************************
+'##::: ##:'##:::::'##::'######:::::'###::::'##::::'##::'######:::
+ ###:: ##: ##:'##: ##:'##... ##:::'## ##::: ##:::: ##:'##... ##::
+ ####: ##: ##: ##: ##: ##:::..:::'##:. ##:: ##:::: ##: ##:::..:::
+ ## ## ##: ##: ##: ##: ##:::::::'##:::. ##: ##:::: ##: ##::'####:
+ ##. ####: ##: ##: ##: ##::::::: #########:. ##:: ##:: ##::: ##::
+ ##:. ###: ##: ##: ##: ##::: ##: ##.... ##::. ## ##::: ##::: ##::
+ ##::. ##:. ###. ###::. ######:: ##:::: ##:::. ###::::. ######:::
+..::::..:::...::...::::......:::..:::::..:::::...::::::......::::
+**********************************************Version: 2.0.1*****
+
+Folder:'/home/test'
+
+Command '['git', '-C', '/home/test', 'log', '--pretty=format:%cs;%ct;%D', '--reverse']' returned non-zero exit status 128.
+```
+
+## Links
+
+- Source: https://github.com/numbworks/nwcommitaverages
+- License: https://github.com/numbworks/nwcommitaverages/blob/master/LICENSE
+
+## Total Downloads (PyPi)
+
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/nwcommitaverages?period=total&units=NONE&left_color=BLACK&right_color=BLUE&left_text=TOTAL+DOWNLOADS)](https://pepy.tech/projects/nwcommitaverages)

nwcommitaverages-2.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+nwcommitaverages.py,sha256=bluldKPfdUR6mm1WEIyuTAMjC9BH6PfRrht6ePCHypE,10307
+nwcommitaveragescli.py,sha256=C60Xs8UOstkj9P6iWKanOOukxdGn86RJFaoIeNegf6k,14728
+setupinfo.py,sha256=eO1b2hkURCT5LotPPCK0S_Ehj33WYys4ZZqDcHmT8Kg,521
+nwcommitaverages-2.0.1.dist-info/METADATA,sha256=jrZZBbKfPloPaqdmS7b3gAOztyM6JTriKkyIvWYFnKs,4777
+nwcommitaverages-2.0.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+nwcommitaverages-2.0.1.dist-info/entry_points.txt,sha256=-1fPgBfCMEm-7bwELkDFtdWjJfGytqrAoENyZAXbPdE,65
+nwcommitaverages-2.0.1.dist-info/top_level.txt,sha256=ALyn6uonUIMxthhxGW0glYBCmfiNp9H8kE-ZiBILy5I,47
+nwcommitaverages-2.0.1.dist-info/RECORD,,

nwcommitaverages-2.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

nwcommitaverages-2.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+nwcommitaveragescli = nwcommitaveragescli:main

nwcommitaverages-2.0.1.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+nwcommitaverages
+nwcommitaveragescli
+setupinfo

nwcommitaverages.py

@@ -0,0 +1,299 @@
+'''
+A CLI application designed to calculate the average time between git commits.
+
+Alias: nwcavg
+'''
+
+# GLOBAL MODULES
+import subprocess
+from collections import defaultdict
+from dataclasses import dataclass
+from datetime import datetime, timezone
+from subprocess import CompletedProcess
+from typing import Optional
+
+# NW/LOCAL MODULES
+# CONSTANTS
+# STATIC CLASSES
+# CLASSES
+@dataclass(frozen = True)
+class CommitItem():
+
+    '''Collects all the necessary information related to a commit timestamp.'''
+
+    date_str : str
+    timestamp_int : int
+    timestamp_dt : datetime
+    ref_names : list[str]
+@dataclass(frozen = True)
+class DailyStatus():
+
+    '''Represents a daily status.'''
+
+    date_str : str
+    timestamps : list[int]
+    avg_minutes : float
+    ref_names : list[str]
+@dataclass(frozen = True)
+class MonthlyStatus():
+
+    '''Represents a monthly status.'''
+
+    year_month : str
+    dates : int
+    timestamps : list[int]
+    avg_minutes : float
+    ref_names : list[str]
+@dataclass(frozen = True)
+class Summary():
+
+    '''Represents a summary.'''
+
+    commit_items : list[CommitItem]
+    daily_statuses : list[DailyStatus]
+    monthly_statuses : list[MonthlyStatus]
+class CommitAverageCalculator():
+    
+    '''Calculates custom averages related to the current git repository.'''
+
+    def __create_timestamp_dt(self, timestamp_int : int) -> datetime:
+
+        '''Converts an integer timestamp to datetime.'''
+
+        dt : datetime = datetime.fromtimestamp(int(timestamp_int), tz = timezone.utc)
+
+        return dt
+    def __create_commit_item(self, triplet_lst : list[str]) -> CommitItem:
+
+        '''Creates a CommitItem object out of the provided arguments.'''
+
+        date_str : str = triplet_lst[0]
+        timestamp_int : int = int(triplet_lst[1])
+        timestamp_dt : datetime = self.__create_timestamp_dt(timestamp_int = timestamp_int) 
+
+        ref_names : list[str] = []
+        if triplet_lst[2]:
+            ref_names =  triplet_lst[2].split(",")
+
+        commit_item : CommitItem = CommitItem(
+            date_str = date_str,
+            timestamp_int = timestamp_int,
+            timestamp_dt = timestamp_dt,
+            ref_names = ref_names
+        ) 
+
+        return commit_item
+    def __update_ref_names(self, commit_item : CommitItem, ref_names : list[str]) -> CommitItem:
+
+        '''Update commit_item.ref_names with ref_names.'''
+
+        updated : CommitItem = CommitItem(
+            date_str = commit_item.date_str,
+            timestamp_int = commit_item.timestamp_int,
+            timestamp_dt = commit_item.timestamp_dt,
+            ref_names = ref_names
+        )
+
+        return updated    
+    def __clean_ref_names(self, ref_names : list[str]) -> list[str]:
+
+        '''Clean branch names.'''
+        
+        if not ref_names:
+            return ref_names
+
+        cleaned : list[str] = []
+
+        for ref_name in ref_names:
+
+            ref_name = ref_name.replace(" ", "")
+
+            if ref_name in ["origin/HEAD", "origin/master", "HEAD->master"]:
+                continue
+          
+            if ref_name.startswith("tag:"):
+                continue
+
+            if ref_name.startswith("origin/"):
+                ref_name = ref_name.replace("origin/", "")
+                cleaned.append(ref_name)
+                continue
+
+        return sorted(set(cleaned))
+    def __create_year_month(self, date_str : str) -> str:
+
+        '''"2023-11-17" -> 2023-11'''
+
+        year_month : str = date_str[:7]
+
+        return year_month
+    def __count_days_in_month(self, daily_statuses : list[DailyStatus]) -> int:
+
+        '''Counts days in month.'''
+
+        return len(set(daily_status.date_str for daily_status in daily_statuses))
+    def __extract_avg_minutes(self, daily_statuses : list[DailyStatus]) -> list[float]:
+
+        '''Extracts the avg_minutes from daily_statuses.'''
+        
+        return [status.avg_minutes for status in daily_statuses]
+    def __get_commit_items(self, folder_path: Optional[str]) -> list[CommitItem]:
+
+        '''
+            Retrieve a collection of CommitItem objects out of the git log.
+
+            git log output:
+                2023-08-16;1692207406;
+                2023-08-21;1692636918;origin/v4.6.0
+                2023-08-21;1692637081;HEAD -> master, origin/master, origin/HEAD
+                ...
+
+            If "folder_path" is None, "git log" is run against the current folder.
+            Otherwise, it's run against the provided folder ("git -C file_path log").
+        '''
+
+        git_command : list[str] = ["git", "log", "--pretty=format:%cs;%ct;%D", "--reverse"]
+
+        if folder_path:
+            git_command = ["git", "-C", folder_path, "log", "--pretty=format:%cs;%ct;%D", "--reverse"]
+
+        output : CompletedProcess = subprocess.run(
+            git_command,
+            capture_output = True,
+            text = True,
+            check = True
+        )
+
+        triplets : list[str] = list(map(str, output.stdout.splitlines()))
+        commit_items : list[CommitItem] = []
+
+        for triplet in triplets:
+            triplet_lst : list[str] = triplet.split(";")
+            commit_item : CommitItem = self.__create_commit_item(triplet_lst = triplet_lst)
+            commit_items.append(commit_item)
+
+        return commit_items
+    def __clean_commit_items(self, commit_items : list[CommitItem]) -> list[CommitItem]:
+
+        '''Cleans every commit_item.ref_names in commit items.'''
+
+        cleaned : list[CommitItem] = []
+
+        for commit_item in commit_items:
+
+            new_ref_names : list[str] = self.__clean_ref_names(ref_names = commit_item.ref_names)
+            new_commit_item : CommitItem = self.__update_ref_names(commit_item = commit_item, ref_names = new_ref_names)
+
+            cleaned.append(new_commit_item)
+
+        return cleaned
+    def __create_daily_statuses(self, commit_items : list[CommitItem]) -> list[DailyStatus]:
+        
+        '''
+        Creates a collection of DailyStatus objects out of commit_items.
+
+        Example:
+        [
+            (date_str = "2023-11-17", timestamps = [1700239075, 1700239305, 1700240579, 1700246557], avg_minutes = 41.57, ref_names = ["ref1", "ref2"]), 
+            (date_str = "2023-11-20", timestamps = [1700508271, 1700508711], avg_minutes = 7.33, ref_names = ["ref3', "ref4']), 
+            ...
+        ]
+        '''
+
+        grouped_by_date : defaultdict = defaultdict(list)
+
+        for item in commit_items:
+            grouped_by_date[item.date_str].append(item)
+
+        daily_statuses : list[DailyStatus] = []
+
+        for date_str, items in grouped_by_date.items():
+
+            timestamps : list[int] = [item.timestamp_int for item in items]
+            timestamps.sort()
+
+            ref_names : list[str] = list({ref for item in items for ref in item.ref_names})
+
+            avg_minutes : float = 0.0
+            if len(timestamps) > 1:
+                differences : list[int] = [timestamps[i + 1] - timestamps[i] for i in range(len(timestamps) - 1)]
+                avg_minutes = round((sum(differences) / len(differences) / 60), 2)
+
+            daily_status : DailyStatus = DailyStatus(date_str = date_str, timestamps = timestamps, avg_minutes = avg_minutes, ref_names = ref_names)
+            daily_statuses.append(daily_status)
+
+        return daily_statuses
+    def __create_monthly_statuses(self, daily_statuses : list[DailyStatus]) -> list[MonthlyStatus]:
+
+        '''
+        Creates a collection of MonthlyStatus objects out of daily_statuses.
+
+        Example:
+        [
+            (year_month = "2023-11", timestamps = [1700239075, 1700239305, 1700240579, 1700246557, 1700508271, 1700508711], avg_minutes = 24.45, ref_names = ["ref1", "ref2", "ref3", "ref4"]),
+            (year_month = "2023-12", timestamps = [...], avg_minutes = ...),
+            ...
+        ]
+        '''
+
+        grouped_by_ym : defaultdict = defaultdict(list)
+
+        for daily_status in daily_statuses:
+            year_month : str = self.__create_year_month(date_str = daily_status.date_str)
+            grouped_by_ym[year_month].append(daily_status)
+
+        monthly_statuses : list[MonthlyStatus] = []
+
+        for year_month, daily_statuses in grouped_by_ym.items():
+
+            dates : int = self.__count_days_in_month(daily_statuses = daily_statuses)
+
+            timestamps : list[int] = []
+            ref_names : list[str] = []
+
+            for daily_status in daily_statuses:
+                timestamps.extend(daily_status.timestamps)
+                ref_names.extend(daily_status.ref_names)
+
+            timestamps.sort()
+            ref_names = sorted(list(set(ref_names)))
+
+            daily_avg_minutes : list[float] = self.__extract_avg_minutes(daily_statuses = daily_statuses)
+
+            monthly_avg_minutes : float = 0.0
+            if len(timestamps) > 1:
+                monthly_avg_minutes = round(sum(daily_avg_minutes) / len(daily_avg_minutes), 2)
+
+            monthly_status : MonthlyStatus = MonthlyStatus(
+                year_month = year_month, 
+                dates = dates, 
+                timestamps = timestamps, 
+                avg_minutes = monthly_avg_minutes, 
+                ref_names = ref_names
+            )
+            
+            monthly_statuses.append(monthly_status)
+
+        return monthly_statuses
+    
+    def run(self, folder_path: Optional[str] = None) -> Summary:
+
+        '''Returns a Summary or raises an Exception.'''
+
+        commit_items : list[CommitItem] = self.__get_commit_items(folder_path)
+        commit_items = self.__clean_commit_items(commit_items = commit_items)
+
+        daily_statuses : list[DailyStatus] = self.__create_daily_statuses(commit_items = commit_items)
+        monthly_statuses : list[MonthlyStatus] = self.__create_monthly_statuses(daily_statuses = daily_statuses)
+       
+        summary : Summary = Summary(
+            commit_items = commit_items,
+            daily_statuses = daily_statuses,
+            monthly_statuses = monthly_statuses
+        )
+
+        return summary
+
+# MAIN
+if __name__ == "__main__":
+    pass

nwcommitaveragescli.py

@@ -0,0 +1,434 @@
+'''
+A CLI application built around nwcommitaverages.
+
+Alias: nwcavg
+'''
+
+# GLOBAL MODULES
+import os
+import subprocess
+import yaml
+from pathlib import Path
+from argparse import ArgumentParser, Namespace
+from enum import StrEnum
+from shutil import get_terminal_size
+from subprocess import CompletedProcess
+from tabulate import tabulate
+from typing import Callable, Final, Optional
+
+# NW/LOCAL MODULES
+from nwcommitaverages import CommitAverageCalculator, MonthlyStatus, Summary
+from setupinfo import CLI_NAME, CLI_DESCRIPTION, PROJECT_VERSION
+
+# GENERIC CLASSES
+# CONSTANTS
+class CLISTRING:
+
+    '''Collects all the CLI-related strings.'''
+
+    OPTION_FOLDERPATH_FLAGS : Final[list[str]] = ["--folder_path"]
+    OPTION_FOLDERPATH_REQUIRED : Final[bool] = False
+    OPTION_FOLDERPATH_HELP : Final[str] = "The path to the Git repository folder for which the average commit value is calculated."
+class HEADER(StrEnum):
+
+    '''Represents a collection of headers.'''
+
+    YEARMONTH = "YearMonth"
+    DAYS = "Days"
+    COMMITS = "Commits"
+    DAILYAVGMIN = "DailyAvgMin"
+    REFNAMES = "RefNames"
+
+# STATIC CLASSES
+class _MessageCollectionAsciiBannerManager():
+
+    '''Collects all the messages used for logging and for the exceptions.'''
+
+    @staticmethod
+    def provided_version_empty_whitespace() -> str:
+        return "The provided 'version' is empty or whitespace."
+class _MessageCollectionCLIManager():
+
+    '''Collects all the messages used for logging and for the exceptions used by CLIManager.'''
+
+    @staticmethod
+    def not_enough_data() -> str:
+        return "Not enough data"
+    @staticmethod
+    def field_equals_to(name: str, value: str) -> str:
+        return f"{name}:'{value}'"
+class _MessageCollection(
+    _MessageCollectionCLIManager,
+    _MessageCollectionAsciiBannerManager):
+
+    '''Collects all the messages used for logging and for the exceptions.'''
+
+    pass
+
+# CLASSES
+class AsciiBannerManager:
+
+    """
+        Creates the ASCII banner for the provided library's version.
+
+        The figlet can be generated using 
+            - 'http://www.network-science.de/ascii/' (font: "banner3-D", width: 120)
+            - 'https://www.askapache.com/online-tools/figlet-ascii/'.
+    """
+
+    def __validate(self, version: str) -> None:
+        
+        """Validates the provided 'version'."""
+
+        if not version or not version.strip():
+            raise ValueError(_MessageCollection.provided_version_empty_whitespace())
+    def __create_figlet(self) -> tuple:
+        
+        """Returns a tuple containing the figlet and its width."""
+        
+        lines : list[str] = [
+            "'##::: ##:'##:::::'##::'######:::::'###::::'##::::'##::'######:::",
+            " ###:: ##: ##:'##: ##:'##... ##:::'## ##::: ##:::: ##:'##... ##::",
+            " ####: ##: ##: ##: ##: ##:::..:::'##:. ##:: ##:::: ##: ##:::..:::",
+            " ## ## ##: ##: ##: ##: ##:::::::'##:::. ##: ##:::: ##: ##::'####:",
+            " ##. ####: ##: ##: ##: ##::::::: #########:. ##:: ##:: ##::: ##::",
+            " ##:. ###: ##: ##: ##: ##::: ##: ##.... ##::. ## ##::: ##::: ##::",
+            " ##::. ##:. ###. ###::. ######:: ##:::: ##:::. ###::::. ######:::",
+            "..::::..:::...::...::::......:::..:::::..:::::...::::::......::::"
+        ]
+
+        return (os.linesep.join(lines), len(lines[0]))
+    def __create_frame(self, version: str, max_length: int) -> tuple:
+        
+        """Returns a tuple containing the frame of the figlet."""
+        
+        version_token : str = f"Version: {version}"
+        
+        margin_length : int = 5
+        total_length : int = max_length - len(version_token) - margin_length
+
+        top_line : str = "*" * max_length
+        bottom_line : str = f"{top_line[:total_length]}{version_token}{'*' * margin_length}"
+
+        return (top_line, bottom_line)
+
+    def create_standard(self, version : str) -> str:
+        
+        """Creates the standard ASCII banner."""
+        
+        self.__validate(version)
+
+        figlet, max_length = self.__create_figlet()
+        top_line, bottom_line = self.__create_frame(version, max_length)
+
+        ascii_banner : str = os.linesep.join([
+            top_line,
+            figlet,
+            bottom_line,
+            ""
+        ])
+
+        return ascii_banner
+    def create_mini(self, version : str) -> str:
+
+        """
+            Creates the mini ASCII banner:
+            
+                *****************
+                * NWCAVG v1.0.0 *
+                *****************
+        """
+
+        self.__validate(version)
+
+        assembly_name : str = "NWCAVG"
+        middle_line : str = f"* {assembly_name} v{version} *"
+        
+        top_line : str = "*" * len(middle_line)
+        bottom_line : str = top_line
+
+        ascii_banner : str = os.linesep.join([
+            top_line,
+            middle_line,
+            bottom_line,
+            ""
+        ])
+
+        return ascii_banner
+    def create(self, version : str, terminal_width : int) -> str:
+
+        """Creates either a standard or mini ASCII banner depending on the terminal width."""
+        
+        _, max_length = self.__create_figlet()
+
+        if max_length <= terminal_width:
+            return self.create_standard(version)
+        else:
+            return self.create_mini(version)
+class TerminalWindowManager:
+
+    '''Handles terminal window size.'''
+
+    __shutil_width_function : Callable[[], Optional[int]]
+    __stty_width_function : Callable[[], Optional[int]]
+
+    cutoff_width : Final[int] = 70
+
+    @staticmethod
+    def default_shutil_width_function() -> Optional[int]:
+
+        """Get terminal width using shutil (multi-platform)."""
+
+        try:
+
+            terminal_width : int = get_terminal_size().columns
+
+            return terminal_width
+        
+        except:
+            return None
+
+    @staticmethod
+    def default_stty_width_function() -> Optional[int]:
+
+        """Get terminal width using stty command (Linux)."""
+
+        try:
+
+            process : CompletedProcess[str] = subprocess.run(
+                ["/bin/sh", "-c", "stty size | cut -d' ' -f2"],
+                capture_output = True,
+                text = True,
+                check = False,
+            )
+
+            stty_output : str = process.stdout.strip()
+            terminal_width : int = int(stty_output)
+
+            if terminal_width >= 0:
+                return terminal_width
+
+            return None
+        except:
+            return None
+
+    def __init__(
+        self,
+        shutil_width_function : Optional[Callable[[], Optional[int]]] = None,
+        stty_width_function : Optional[Callable[[], Optional[int]]] = None,
+    ) -> None:
+        
+        if shutil_width_function is None:
+            shutil_width_function = self.default_shutil_width_function
+        
+        if stty_width_function is None:
+            stty_width_function = self.default_stty_width_function
+
+        self.__shutil_width_function = shutil_width_function
+        self.__stty_width_function = stty_width_function
+
+    def get_or_cutoff(self) -> int:
+
+        terminal_width : Optional[int] = self.__shutil_width_function()
+
+        if terminal_width is None:
+            terminal_width = self.__stty_width_function()
+
+        if terminal_width is None:
+            terminal_width = self.cutoff_width
+
+        return terminal_width
+class APFactory():
+
+    '''Encapsulates all the logic related to the creation of a custom instance of argparse.ArgumentParser.'''
+
+    def create(self) -> ArgumentParser:
+
+        '''Creates a custom instance of argparse.ArgumentParser.'''
+
+        argument_parser : ArgumentParser = ArgumentParser(prog = CLI_NAME, description = CLI_DESCRIPTION)
+
+        argument_parser.add_argument(
+            *CLISTRING.OPTION_FOLDERPATH_FLAGS, 
+            required = CLISTRING.OPTION_FOLDERPATH_REQUIRED, 
+            help = CLISTRING.OPTION_FOLDERPATH_HELP)
+
+        return argument_parser
+class APAdapter():
+
+    '''Customizes argparse.ArgumentParser for this use case.'''
+
+    __ap_factory : APFactory
+
+    def __init__(self, ap_factory : APFactory = APFactory()) -> None:
+        self.__ap_factory = ap_factory
+
+    def parse_args(self) -> Optional[str]:
+
+        '''Parses provided arguments.'''
+
+        parser : ArgumentParser = self.__ap_factory.create()
+        args : Namespace = parser.parse_args()
+
+        return args.folder_path
+class CLIManager():
+
+    '''Collects all the logic related to the CLI management.'''
+
+    __ap_adapter : APAdapter
+    __ca_calculator : CommitAverageCalculator
+    __ascii_banner_manager : AsciiBannerManager
+    __tw_manager : TerminalWindowManager
+    __logging_function : Callable[[str], None]
+
+    def __init__(
+        self, 
+        ap_adapter : APAdapter = APAdapter(), 
+        ca_calculator : CommitAverageCalculator = CommitAverageCalculator(),
+        ascii_banner_manager : AsciiBannerManager = AsciiBannerManager(),
+        tw_manager : TerminalWindowManager = TerminalWindowManager(),
+        logging_function : Callable[[str], None] = lambda msg : print(msg)) -> None:
+        
+        self.__ap_adapter = ap_adapter
+        self.__ca_calculator = ca_calculator
+        self.__ascii_banner_manager = ascii_banner_manager
+        self.__tw_manager = tw_manager
+        self.__logging_function = logging_function
+
+    def __convert_to_table(self, monthly_statuses : list[MonthlyStatus]) -> str:
+
+        '''
+            Converts monthly_statuses to a table.
+        
+            Example:
+                +-------------+--------+-----------+---------------+--------------------------------+
+                | YearMonth   |   Days |   Commits |   DailyAvgMin | RefNames                       |
+                +=============+========+===========+===============+================================+
+                | 2023-08     |      2 |         6 |        721.28 |  v3.2.0, v3.3.0                |
+                +-------------+--------+-----------+---------------+--------------------------------+
+                ...
+        '''
+
+        rows : list[list[object]] = []
+
+        for monthly_status in monthly_statuses:
+            row : list[object] = [
+                monthly_status.year_month,
+                monthly_status.dates,
+                len(monthly_status.timestamps),
+                str(f"{monthly_status.avg_minutes:.2f}"),
+                ", ".join(monthly_status.ref_names)
+            ]
+            row[3] = str(row[3]).replace("0.00", _MessageCollection.not_enough_data())
+            rows.append(row)
+
+        table : str = tabulate(
+            rows, 
+            headers = [HEADER.YEARMONTH, HEADER.DAYS, HEADER.COMMITS, HEADER.DAILYAVGMIN, HEADER.REFNAMES], 
+            tablefmt = "grid", 
+            disable_numparse = True
+        )
+
+        return table
+    def __calculate_table_max_lenght(self, table : str) -> int:
+
+        """Calculates table's max lenght."""
+
+        max_length : int = max((len(line) for line in table.splitlines()), default=0)
+
+        return max_length
+    def __convert_to_yaml(self, monthly_statuses : list[MonthlyStatus]) -> str:
+        
+        '''
+            Converts monthly_statuses to a YAML block.
+        
+            Example:
+                - YearMonth: "2023-08"
+                  Days: 2
+                  Commits: 6
+                  DailyAvgMin: 721.28
+                  RefNames: "v3.2.0, v3.3.0"
+                - ...
+
+            Note: "sort_keys = False" preserves the insertion order of the headers.
+        '''
+       
+        yaml_data : list[dict[str, object]] = []
+
+        for monthly_status in monthly_statuses:
+            avg_min = str(f"{monthly_status.avg_minutes:.2f}").replace("0.00", _MessageCollection.not_enough_data())
+            
+            record : dict[str, object] = {
+                HEADER.YEARMONTH.value: monthly_status.year_month,
+                HEADER.DAYS.value: monthly_status.dates,
+                HEADER.COMMITS.value: len(monthly_status.timestamps),
+                HEADER.DAILYAVGMIN.value: float(avg_min) if avg_min.replace('.', '', 1).isdigit() else avg_min,
+                HEADER.REFNAMES.value: ", ".join(monthly_status.ref_names)
+            }
+            yaml_data.append(record)
+
+        yaml_str : str = yaml.dump(yaml_data, sort_keys = False, default_flow_style = False)
+        yaml_str = yaml_str.replace(f"\n- {HEADER.YEARMONTH.value}:", f"\n\n- {HEADER.YEARMONTH.value}:")
+
+        return yaml_str
+    
+    def __log_ascii_banner(self):
+
+        """Logs the ascii banner."""
+
+        terminal_width : int = self.__tw_manager.get_or_cutoff()
+        ascii_banner : str = self.__ascii_banner_manager.create(PROJECT_VERSION, terminal_width)
+
+        self.__logging_function("")
+        self.__logging_function(ascii_banner)
+    def __log_folder_path(self, folder_path : Optional[str]):
+
+        """Logs the folder_path."""
+
+        if (folder_path):
+            self.__logging_function(_MessageCollection.field_equals_to("Folder", folder_path))
+        else:
+            self.__logging_function(_MessageCollection.field_equals_to("Folder", str(Path.cwd())))
+
+        self.__logging_function("")     
+    def __log_monthly_statuses(self, monthly_statuses : list[MonthlyStatus]) -> None:
+
+        '''
+            Logs monthly_statuses as table or YAML.
+        '''
+
+        terminal_width : int = self.__tw_manager.get_or_cutoff()
+
+        table : str = self.__convert_to_table(monthly_statuses)
+        table_max_length : int = self.__calculate_table_max_lenght(table)
+
+        if table_max_length < terminal_width:
+            self.__logging_function(table)
+        else:
+            yaml_str : str = self.__convert_to_yaml(monthly_statuses)
+            self.__logging_function(yaml_str)  
+   
+    def parse(self) -> None:
+
+        '''Calculates the average commit value and logs the result.'''
+
+        try:
+
+            self.__log_ascii_banner()
+
+            folder_path : Optional[str] = self.__ap_adapter.parse_args()
+
+            self.__log_folder_path(folder_path = folder_path)
+
+            summary : Summary = self.__ca_calculator.run(folder_path = folder_path)
+            self.__log_monthly_statuses(monthly_statuses = summary.monthly_statuses);
+
+        except Exception as e:
+
+            self.__logging_function(str(e))
+
+# MAIN
+def main(): CLIManager().parse()
+
+if __name__ == "__main__":
+    main()

setupinfo.py

@@ -0,0 +1,14 @@
+'''Contains project information.'''
+
+# INFORMATION
+PROJECT_VERSION : str = "2.0.1"
+PROJECT_AUTHOR : str = "numbworks"
+PROJECT_ALIAS : str = "nwcavg"
+
+LIBRARY_NAME : str = "nwcommitaverages"
+LIBRARY_DESCRIPTION : str = "A library designed to calculate the average time between Git commits."
+
+CLI_NAME : str = "nwcommitaveragescli"
+CLI_DESCRIPTION : str = "A CLI application designed to calculate the average time between Git commits."
+
+PROJECT_URL : str = f"https://github.com/{PROJECT_AUTHOR}/{LIBRARY_NAME}"