gh-profiler 0.1.0__tar.gz

gh_profiler-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+.venv/
+__pycache__/
+
+.DS_Store
+

gh_profiler-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

gh_profiler-0.1.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.4
+Name: gh-profiler
+Version: 0.1.0
+Summary: Examine a GH user's profile, and help quickly decide how much to invest in their contributions.
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+gh-profiler
+===
+
+Like many, I've gotten waves of open source contributions where many of the new issues and PRs aren't worth engaging with. But it takes me a bit of time to sort through each of them.
+
+People like to say that code should "speak for itself", but I've found that looking at a GitHub user's profile has been more helpful in making a quick determination about how much time to invest in the issue or PR. I typically look at a few quick things:
+
+- Has the person made an unusually high number of PRs lately?
+- Have a significant portion of these PRs been closed without merging?
+- Have they opened an excessive number of issues?
+- How old is the account?
+- Is there any meaningful information on their profile?
+
+I don't make a final decision about PRs and issues based on the answers to these questions, but many times I see enough red flags here that I have a good idea not to spend much time evaluating the contribution. (I'm mostly talking about PRs and issues where there's been no prior discussion, and there's a lot of text or changes in the PR/issue to review if I'm going to take it seriously.)
+
+The goal of this project is to get a quick snapshot of this kind of information, without having to do a bunch of clicking on GitHub. The output is a summary of what's found, with a quick visual cue as to which factors support investing time in the PR/issue, and which factors suggest it's better off being closed and ignored. I have no interest in calculating some kind of trust score, or any other single number.
+
+Usage
+---
+

gh_profiler-0.1.0/README.md

@@ -0,0 +1,20 @@
+gh-profiler
+===
+
+Like many, I've gotten waves of open source contributions where many of the new issues and PRs aren't worth engaging with. But it takes me a bit of time to sort through each of them.
+
+People like to say that code should "speak for itself", but I've found that looking at a GitHub user's profile has been more helpful in making a quick determination about how much time to invest in the issue or PR. I typically look at a few quick things:
+
+- Has the person made an unusually high number of PRs lately?
+- Have a significant portion of these PRs been closed without merging?
+- Have they opened an excessive number of issues?
+- How old is the account?
+- Is there any meaningful information on their profile?
+
+I don't make a final decision about PRs and issues based on the answers to these questions, but many times I see enough red flags here that I have a good idea not to spend much time evaluating the contribution. (I'm mostly talking about PRs and issues where there's been no prior discussion, and there's a lot of text or changes in the PR/issue to review if I'm going to take it seriously.)
+
+The goal of this project is to get a quick snapshot of this kind of information, without having to do a bunch of clicking on GitHub. The output is a summary of what's found, with a quick visual cue as to which factors support investing time in the PR/issue, and which factors suggest it's better off being closed and ignored. I have no interest in calculating some kind of trust score, or any other single number.
+
+Usage
+---
+

gh_profiler-0.1.0/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "gh-profiler"
+version = "0.1.0"
+description = "Examine a GH user's profile, and help quickly decide how much to invest in their contributions."
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = []
+
+[project.scripts]
+gh-profiler = "gh_profiler.main:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

gh_profiler-0.1.0/src/gh_profiler/__init__.py

@@ -0,0 +1 @@
+"""Make gh_profiler a package."""

gh_profiler-0.1.0/src/gh_profiler/__main__.py

@@ -0,0 +1,7 @@
+"""Allow project to run as a module."""
+
+from .main import main
+
+
+if __name__ == "__main__":
+    main()

gh_profiler-0.1.0/src/gh_profiler/main.py

@@ -0,0 +1,52 @@
+"""Examine a user's profile, and highlight evidence they're human or AI.
+
+The goal is to help make quick, evidence-based decisions about how much time
+to invest in reviewing PRs, and general interaction on open source projects.
+
+Scores:
+3: green
+2: yellow
+1: red
+
+Package, so usage can be:
+$ uvx gh-profiler ehmatthes
+
+Or, maybe from within a project:
+$ uvx gh-profiler <pr-num>
+
+Given a PR number, it finds the author of the PR and runs the profiler on that
+user?
+"""
+
+import sys
+
+from .utils.profile_data import profile_data as pdata
+from .utils import profile_utils
+from .utils import analysis_utils
+from .utils import summary_utils
+
+
+gh_user = sys.argv[1]
+pdata.username = gh_user
+
+
+def main():
+    # Get all information we'll need about the user's profile.
+    profile_utils.get_profile_info()
+
+    # How old is the account?
+    analysis_utils.process_account_age()
+
+    # How much profile information is available?
+    analysis_utils.process_profile_info()
+
+    # What does recent PR activity look like?
+    profile_utils.get_pr_activity()
+    analysis_utils.process_pr_activity()
+
+    # Summarize findings.
+    summary_utils.show_summary()
+
+
+if __name__ == "__main__":
+    main()

gh_profiler-0.1.0/src/gh_profiler/utils/__init__.py

@@ -0,0 +1 @@
+"""Make utils/ modules importable."""

gh_profiler-0.1.0/src/gh_profiler/utils/analysis_utils.py

@@ -0,0 +1,53 @@
+"""Utils for analyzing account information."""
+
+from datetime import datetime as dt
+from datetime import timezone as tz
+
+from .profile_data import profile_data as pdata
+from . import flags
+
+
+def process_account_age():
+    """Evaluate account age."""
+    ts_created = dt.fromisoformat(pdata.profile_info["created_at"])
+    pdata.account_age = dt.now(tz.utc) - ts_created
+
+    if pdata.account_age.days > 3 * 365:
+        pdata.flag_age = flags.green_flag
+    elif pdata.account_age.days > 90:
+        pdata.flag_age = yellow_flag
+    else:
+        pdata.flag_age = flags.red_flag
+
+def process_profile_info():
+    """Evaluate available profile information.
+
+    Focus on: name, company, blog, lcoation, email, bio
+    """
+    fields = ["name", "company", "blog", "location", "email", "bio"]
+    pdata.profile_dict = {field:pdata.profile_info[field] for field in fields}
+
+    num_filled = sum(v not in (None, "") for v in pdata.profile_dict.values())
+    if num_filled == 0:
+        pdata.flag_profile = flags.red_flag
+    elif num_filled < 3:
+        pdata.flag_profile = flags.yellow_flag
+    else:
+        pdata.flag_profile = flags.green_flag
+
+
+def process_pr_activity():
+    """Evaluate recent PR activity."""
+    ratio_merged = pdata.merged_count / pdata.opened_count
+    ratio_closed = pdata.closed_count / pdata.opened_count
+
+    if ratio_closed > 0.5:
+        pdata.flag_closed_pr = flags.red_flag
+    elif ratio_closed > 0.15:
+        pdata.flag_closed_pr = flags.yellow_flag
+    else:
+        pdata.flag_closed_pr = flags.green_flag
+
+    pdata.flag_merged_pr = None
+    if ratio_merged > 0.5:
+        pdata.flag_merged_pr = flags.green_flag

gh_profiler-0.1.0/src/gh_profiler/utils/flags.py

@@ -0,0 +1,5 @@
+"""Flags used for summarizing findings."""
+
+red_flag = "\U0001f534"
+yellow_flag = "\U0001f7e1"
+green_flag = "\U0001f7e2"

gh_profiler-0.1.0/src/gh_profiler/utils/infra_utils.py

@@ -0,0 +1,11 @@
+"""Utils not really specific to GitHub."""
+
+import shlex
+import subprocess
+
+
+def run_cmd(cmd):
+    """Run a subprocess command, return stdout."""
+    cmd_parts = shlex.split(cmd)
+    output_obj = subprocess.run(cmd_parts, capture_output=True)
+    return output_obj.stdout.decode()

gh_profiler-0.1.0/src/gh_profiler/utils/profile_data.py

@@ -0,0 +1,23 @@
+"""One place to store all data about the user."""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class ProfileData:
+    username: str = ""
+
+    profile_info: dict | None = None
+
+    account_age: int = 0
+
+    opened_count: int = 0
+    merged_count: int = 0
+    closed_count: int = 0
+
+    flag_age: str = ""
+    flag_merged_pr: str = ""
+    flag_closed_pr: str = ""
+
+
+profile_data = ProfileData()

gh_profiler-0.1.0/src/gh_profiler/utils/profile_utils.py

@@ -0,0 +1,33 @@
+"""Utils for retrieving user information."""
+
+import json
+from datetime import datetime as dt
+from datetime import timezone as tz
+from datetime import timedelta
+from urllib.parse import quote
+
+from .profile_data import profile_data as pdata
+from . import infra_utils
+
+
+def get_profile_info():
+    """Get all the profile info we'll need."""
+    cmd = f"gh api users/{pdata.username} --jq '{{login, name, created_at, company, blog, location, email, bio}}'"
+    profile_info = infra_utils.run_cmd(cmd)
+    pdata.profile_info = json.loads(profile_info)
+
+
+def get_pr_activity():
+    """Get information about recent PR activity."""
+    cutoff = (dt.now(tz.utc) - timedelta(days=21)).date().isoformat()
+    base_query = f"author:{pdata.username} is:pr created:>={cutoff}"
+
+    opened_cmd = f'gh api "search/issues?q={quote(base_query)}" --jq .total_count'
+    merged_cmd = (
+        f'gh api "search/issues?q={quote(base_query + " is:merged")}" --jq .total_count'
+    )
+    closed_cmd = f'gh api "search/issues?q={quote(base_query + " is:closed -is:merged")}" --jq .total_count'
+
+    pdata.opened_count = int(infra_utils.run_cmd(opened_cmd).strip())
+    pdata.merged_count = int(infra_utils.run_cmd(merged_cmd).strip())
+    pdata.closed_count = int(infra_utils.run_cmd(closed_cmd).strip())

gh_profiler-0.1.0/src/gh_profiler/utils/summary_utils.py

@@ -0,0 +1,64 @@
+"""Utils for summarizing findings."""
+
+from .profile_data import profile_data as pdata
+from . import flags
+
+
+def show_summary():
+    """Show a concise summary of what was found."""
+    # Username, account age:
+    print(f"\nGitHub user: {pdata.username}")
+    print(f"  {pdata.flag_age} Account age: {pdata.account_age.days} days")
+
+    # Available profile information:
+    if pdata.flag_profile == flags.red_flag:
+        print(f"\n  {pdata.flag_profile} No profile information has been provided.")
+    else:
+        _show_profile_dict()
+    
+    # Recent PR activity:
+    print()
+    if pdata.opened_count >= 10:
+        # Only show merged if it's a good sign.
+        if pdata.flag_merged_pr == flags.green_flag:
+            print(
+                f"  {pdata.flag_merged_pr} {pdata.merged_count} of {pdata.opened_count} PRs have been merged in the last 21 days."
+            )
+        print(
+            f"  {pdata.flag_closed_pr} {pdata.closed_count} of {pdata.opened_count} PRs have been closed without merging in the last 21 days."
+        )
+    else:
+        print(
+            f"  {flags.green_flag} {pdata.username} has opened fewer than 10 PRs in the last 21 days."
+        )
+    print("")
+
+
+# --- Helper functions ---
+
+def _show_profile_dict():
+    """Summarize information from the user's profile dict."""
+    print(f"\n  {pdata.flag_profile} Profile information:")
+
+    for k, v in pdata.profile_dict.items():
+        if v and k != "bio":
+            print(f"      {k}: {v}")
+        elif k == "bio":
+            _show_bio(v)
+        else:
+            print(f"      {k}:")
+
+def _show_bio(bio):
+    """Show a bio appropriately."""
+    if bio in (None, ""):
+        print(f"      bio:")
+        return
+        
+    if bio.count("\n") == 0:
+        print(f"      bio: {bio}")
+        return
+
+    # Print a multi-line bio.
+    print("      bio:")
+    for line in bio.splitlines():
+        print(f"        {line}")

gh_profiler-0.1.0/uv.lock

@@ -0,0 +1,8 @@
+version = 1
+revision = 3
+requires-python = ">=3.14"
+
+[[package]]
+name = "gh-profiler"
+version = "0.1.0"
+source = { editable = "." }