git-archaeologist 1.0.0__py3-none-any.whl

git_archaeologist/analyzer.py

@@ -0,0 +1,112 @@
+import git
+from dataclasses import dataclass
+from datetime import timedelta
+
+@dataclass
+class RepositoryStats:
+        commits: int
+        contributors: set
+        files: int
+        insertions: int
+        deletions: int
+        lines: int
+        first_commit: object
+        latest_commit: object
+        lifespan: object
+        largest_gap: object
+        gap_start: object
+        gap_end: object
+        most_active_month: object
+        most_active_month_commits: int
+        history: list
+
+def analyze_repo(path):
+        repo = git.Repo(path)
+        commits = list(repo.iter_commits("--all"))
+        
+        if not commits:
+                return RepositoryStats(
+            commits=0,
+            contributors=set(),
+            files=0,
+            insertions=0,
+            deletions=0,
+            lines=0,
+            first_commit=None,
+            latest_commit=None,
+            lifespan=None,
+            largest_gap=None,
+            gap_start=None,
+            gap_end=None,
+            most_active_month=None,
+            most_active_month_commits=0
+            )
+        
+        first_commit = min(commits, key=lambda commit: commit.committed_datetime)
+        latest_commit = max(commits, key=lambda commit: commit.committed_datetime)
+        lifespan = latest_commit.committed_datetime - first_commit.committed_datetime
+        sorted_commits = sorted(commits, key=lambda commit: commit.committed_datetime)
+        history = []
+        
+        unique_contrib = set()
+        files = set()
+        total_insertions = 0
+        total_deletions = 0
+        total_lines = 0
+        monthly_commits = {}
+        for commit in commits:
+                unique_contrib.add(commit.author.name)
+                total_deletions += commit.stats.total['deletions']
+                total_insertions += commit.stats.total['insertions']
+                total_lines += commit.stats.total["lines"]
+                
+                year = commit.committed_datetime.year 
+                month = commit.committed_datetime.month
+                key = (year, month)
+                monthly_commits[key] = monthly_commits.get(key, 0) + 1
+                history.append((
+                commit.hexsha,
+                commit.committed_datetime,
+                commit.message,
+                commit.author
+                ))
+                for file in commit.stats.files:
+                        files.add(file)
+        number_files = len(files)
+        most_active_month = max(monthly_commits, key=monthly_commits.get)
+        
+        largest_gap = timedelta(0)
+        gap_start = None
+        gap_end = None
+        
+        for previous, current in zip(sorted_commits[:-1], sorted_commits[1:]):
+                gap =  current.committed_datetime - previous.committed_datetime
+                if gap > largest_gap:
+                        largest_gap = gap
+                        gap_start = previous
+                        gap_end = current
+                        
+        return RepositoryStats(
+                commits=len(commits),
+                contributors=unique_contrib,
+                files=number_files,
+                insertions=total_insertions,
+                deletions=total_deletions,
+                lines=total_lines,
+                first_commit=first_commit,
+                latest_commit=latest_commit,
+                lifespan=lifespan,
+                largest_gap=largest_gap,
+                gap_start=gap_start,
+                gap_end=gap_end,
+                most_active_month=most_active_month,
+                most_active_month_commits=monthly_commits[most_active_month],
+                history=history
+        )
+
+
+# CONGRATS YOU HAVE FOUND THE SECOND EASTER EGG!!!! 
+# KEEP GOING!!!!!!
+# HOPE YOU LIKE THE PROGRAM
+# MADE BY: OMAR GAMAL ELHALABY 
+# RATE IF YOU LIKE, OR LEAVE A COMMENT (IF FOUND ON HACKCLUB)!

git_archaeologist/cli.py

@@ -0,0 +1,243 @@
+import argparse
+from pathlib import Path
+import git
+from git.exc import NoSuchPathError, InvalidGitRepositoryError
+from git_archaeologist.analyzer import analyze_repo
+import json
+
+def validator(path_str):
+    try:
+        path = Path(path_str)
+        git.Repo(path)
+    except NoSuchPathError:
+        raise argparse.ArgumentTypeError("ERROR: No such path")
+    except InvalidGitRepositoryError:
+        raise argparse.ArgumentTypeError("ERROR: git repository not found")
+    return path
+
+
+def print_header():
+    print("Git Archaeologist")
+    print("===========================\n")
+
+
+def print_timeline_section(stats):
+    print("REPOSITORY TIMELINE")
+    print("---------------------------")
+    print(f"First Commit: {stats.first_commit.committed_datetime}")
+    print(f"Last Commit: {stats.latest_commit.committed_datetime}")
+    print(f"Lifespan: {stats.lifespan}")
+
+
+def print_timeline(stats):
+    print_header()
+    print_timeline_section(stats)
+
+
+def print_activity_section(stats):
+    print("REPOSITORY ACTIVITY")
+    print("---------------------------")
+    print(
+        f"Most active month: "
+        f"{stats.most_active_month[1]}/{stats.most_active_month[0]}"
+    )
+    print(
+        f"Commits in the most active month: "
+        f"{stats.most_active_month_commits}"
+    )
+
+    if stats.largest_gap:
+        print(f"Longest inactivity: {stats.largest_gap}")
+    else:
+        print("Longest inactivity: 0 days")
+
+    if stats.gap_start is None:
+        print("From: No Gap!")
+    else:
+        print(f"From: {stats.gap_start.committed_datetime}")
+
+    if stats.gap_end is None:
+        print("To: No Gap!")
+    else:
+        print(f"To: {stats.gap_end.committed_datetime}")
+
+
+def print_activity(stats):
+    print_header()
+    print_activity_section(stats)
+
+
+def print_summary_section(stats):
+    print("REPOSITORY SUMMARY")
+    print("---------------------------")
+    print(f"Commits: {stats.commits}")
+    print(f"Contributors: {stats.contributors}")
+    print(f"Files: {stats.files}")
+    print(f"Insertions: {stats.insertions}")
+    print(f"Deletions: {stats.deletions}")
+    print(f"Lines Changed: {stats.lines}\n")
+
+    print("CONTRIBUTORS")
+    print("---------------------------")
+
+    for name in stats.contributors:
+        print(name)
+
+
+def print_summary(stats):
+    print_header()
+    print_summary_section(stats)
+
+def print_history(stats):
+    print_header()
+    print("COMMIT HISTORY")
+    print("---------------------------")
+    commit_num = 0
+    
+    for commit in stats.history:
+        commit_num += 1
+        print(f"Commit number: {commit_num}")
+        print(f"Commit SHA1 (first 7 digits): {stats.history[commit_num - 1][0][:7]}")
+        print(f"Commit Date/Time: {stats.history[commit_num - 1][1]}")
+        print(f"Commit message: {stats.history[commit_num - 1][2]}")
+        print(f"Commit author(s): {stats.history[commit_num - 1][3]}\n")
+
+def print_json(stats):
+    dict_stats = vars(stats)
+    dict_stats["contributors"] = list(stats.contributors)
+    dict_stats["largest_gap"] = str(stats.largest_gap)
+    dict_stats["gap_start"] =(
+        str(stats.gap_start.committed_datetime)
+        if stats.gap_start else None
+    )
+    dict_stats["gap_end"] = (
+        str(stats.gap_end.committed_datetime)
+        if stats.gap_end else None
+    )
+    
+    dict_stats["first_commit"] = (
+        str(stats.first_commit.committed_datetime)
+        if stats.first_commit else None
+    )
+    
+    dict_stats["latest_commit"] = (
+        str(stats.latest_commit.committed_datetime)
+        if stats.latest_commit else None
+    )
+    
+    dict_stats["lifespan"] = str(stats.lifespan)
+    history = []
+    commit_number = 0
+    for commit_hash, date, message, author in stats.history:
+        commit_number += 1
+        history.append({
+            "number": (commit_number),
+            "commit SHA1": commit_hash,
+            "date":str(date),
+            "message": message.strip(),
+            "author(s)": str(author)
+        })
+        dict_stats["history"] = history
+    print(json.dumps(dict_stats, indent=4))
+
+def print_all(stats):
+    print_header()
+
+    print("REPOSITORY OVERVIEW")
+    print("---------------------------")
+    print(f"Commits: {stats.commits}")
+    print(f"Contributors: {len(stats.contributors)}")
+    print(f"Num. of Files: {stats.files}")
+    print(f"Insertions: {stats.insertions}")
+    print(f"Deletions: {stats.deletions}")
+    print(f"Lines Changed: {stats.lines}\n")
+
+    print_timeline_section(stats)
+    print()
+    print_activity_section(stats)
+    print()
+    print_summary_section(stats)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="A git tool to view information regarding repositories"
+    )
+    output_group = parser.add_mutually_exclusive_group()
+
+    parser.add_argument(
+        "repository",
+        type=validator,
+        help="Path to repository"
+    )
+
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version="1.0.0",
+        help="show the program's version",
+    )
+
+    output_group.add_argument(
+        "-s",
+        "--summary",
+        action="store_true",
+        help="show a simple summary"
+    )
+
+    output_group.add_argument(
+        "-t",
+        "--timeline",
+        action="store_true",
+        help="show a simple timeline for the repository"
+    )
+
+    output_group.add_argument(
+        "-a",
+        "--activity",
+        action="store_true",
+        help="show a simple activity dashboard for the repository"
+    )
+    
+    output_group.add_argument(
+        "--history",
+        action="store_true",
+        help="show the history of the repository"
+    )
+    
+    output_group.add_argument(
+        "-j",
+        "--json",
+        action="store_true",
+        help="output repository statistics as JSON"
+    )
+
+    parsed_args = parser.parse_args()
+    stats = analyze_repo(parsed_args.repository)
+    if stats.commits == 0:
+        print_header()
+        print("ERROR: Repository has no commits.")
+        return
+
+    if parsed_args.timeline:
+        print_timeline(stats)
+    elif parsed_args.activity:
+        print_activity(stats)
+    elif parsed_args.summary:
+        print_summary(stats)
+    elif parsed_args.history:
+        print_history(stats)
+    elif parsed_args.json:
+        print_json(stats)
+    else:
+        print_all(stats)
+
+
+if __name__ == "__main__":
+    main()
+
+
+# HOPE YOU'RE HAPPY WITH THE TOOL!!!!!!!
+# MADE BY: OMAR ELHALABY
+# CONGRATS ON FINDING THE THIRD EASYER EGG!!

git_archaeologist-1.0.0.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: git-archaeologist
+Version: 1.0.0
+Summary: A CLI tool for analyzing Git repository history
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: GitPython
+
+# Git Archaeologist
+A python CLI tool for quickly analyzing and exploring the history of Git repositories.
+
+# Problem
+Understanding a Git repository's history can be very time consuming when done manually. Git provides a huge amount of information, but finding useful patterns-such as the repository's lifespan, periods of inactivity, most active months, contributors, and commit history-often requires running multiple commands and manually interpreting the results.
+
+__Git Archaeologist__ simplifies this process by collecting important repository statistics and presenting them in a clear human-readable format or a JSON format for developers.
+
+# Features
+
+- Repository summary
+    -  Total commits
+    -  Number of contributors
+    -  Number of lines changed
+    -  Total insertions
+    -  Total deletions
+    -  Total lines changed
+
+- Timeline analysis
+    -  First commit
+    -  Latest commit
+    -  Repo Lifespan
+
+- Activity analysis
+    -  Most active month
+    -  Number of commits during the most active month
+    -  Longest period of inactivity
+    -  Commits marking the begining and end of the longest gap
+
+- Commit History
+    -  Commit SHA1
+    -  Commit data
+    -  Commit message
+    -  Author
+
+- JSON output
+    -  Machine-readable repository statistics
+    -  Useful for scripts, automation and other apps
+
+# Installation
+
+Clone the repository:
+
+``` bash
+$ git clone https://github.com/omarelhalaby76-coder/git-archaeologist
+$ cd git-archaeologist
+```
+Install the dependencies:
+``` bash
+$ pip install -r requirments.txt
+```
+Or install the project directly:
+``` bash
+$ pip install .
+```

git_archaeologist-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+git_archaeologist/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+git_archaeologist/analyzer.py,sha256=mxQLEgwnvIUA9FFzBO0wMAn5EAW1Y7rf6YDsBUOKnaQ,3860
+git_archaeologist/cli.py,sha256=_gSGNu4P2L8kGfejFVJRHzu0eQID7Kk_1YyVIysRcTI,6480
+git_archaeologist-1.0.0.dist-info/METADATA,sha256=LlaGaDhhPY71-xmFkcmd5RBQnt34l4N5Mltv7M1ldqQ,1813
+git_archaeologist-1.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+git_archaeologist-1.0.0.dist-info/entry_points.txt,sha256=CCaVx5vkVbWYlgHoMmstVpuYDxnESzBshhKuHkOJYac,65
+git_archaeologist-1.0.0.dist-info/top_level.txt,sha256=dUOvLs7-v4cBBpzSJghnkHJWms7Ofwf3Zn__Rn-p07o,18
+git_archaeologist-1.0.0.dist-info/RECORD,,

git_archaeologist-1.0.0.dist-info/WHEEL

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

git_archaeologist-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+git-archaeologist = git_archaeologist.cli:main

git_archaeologist-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+git_archaeologist