👌 IMPROVE: since/until: assume git reference, fallback to datetime

Author: consideRatio

github_activity/cli.py

@@ -3,6 +3,7 @@
 import sys
 
 from .github_activity import generate_activity_md
+from .git import _git_installed_check
 
 DESCRIPTION = "Generate a markdown changelog of GitHub activity within a date window."
 parser = argparse.ArgumentParser(description=DESCRIPTION)
@@ -83,6 +84,10 @@
 
 
 def main():
+    if not _git_installed_check():
+        print("git is required to run github-activity")
+        sys.exit(1)
+
     args = parser.parse_args(sys.argv[1:])
     tags = args.tags.split(",") if args.tags is not None else args.tags
     md = generate_activity_md(

github_activity/git.py

@@ -0,0 +1,18 @@
+import subprocess
+
+def _git_installed_check():
+    cmd = ["git", "--help"]
+    try:
+        subprocess.check_call(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        return True
+    except subprocess.CalledProcessError:
+        return False
+
+
+def _valid_git_reference_check(git_ref):
+    cmd = ["git", "rev-parse", "--verify", git_ref]
+    try:
+        subprocess.check_call(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        return True
+    except subprocess.CalledProcessError:
+        return False

github_activity/github_activity.py

@@ -3,9 +3,11 @@
 import dateutil
 import pytz
 import requests
+import sys
 import urllib
 from pathlib import Path
 
+from .git import _valid_git_reference_check
 from .graphql import GitHubGraphQlQuery
 from .cache import _cache_data
 import pandas as pd
@@ -475,22 +477,21 @@ def _parse_target(target):
 
 
 def _get_datetime_and_type(org, repo, datetime_or_git_ref):
-    """Return a datetime object and bool."""
+    """Return a datetime object and bool indicating if it is a git reference or
+    not."""
 
-    is_git_ref = False
+    # Default a blank datetime_or_git_ref to current UTC time, which makes sense
+    # to set the until flags default value.
     if datetime_or_git_ref is None:
         dt = datetime.datetime.now().astimezone(pytz.utc)
+        return (dt, False)
+
+    if _valid_git_reference_check(datetime_or_git_ref):
+        dt = _get_datetime_from_git_ref(org, repo, datetime_or_git_ref)
+        return (dt, True)
     else:
-        try:
-            dt = dateutil.parser.parse(datetime_or_git_ref)
-        except ValueError as e:
-            if repo:
-                dt = _get_datetime_from_git_ref(org, repo, datetime_or_git_ref)
-                is_git_ref = True
-            else:
-                raise e
-
-    return dt, is_git_ref
+        dt = dateutil.parser.parse(datetime_or_git_ref)
+        return (dt, False)
 
 
 def _get_datetime_from_git_ref(org, repo, ref):

setup.py

@@ -19,7 +19,7 @@
     name="github_activity",
     version=version,
     include_package_data=True,
-    python_requires=">=3.4",
+    python_requires=">=3.6",
     author="Chris Holdgraf",
     author_email="choldgraf@berkeley.edu",
     url="https://jupyter.org/",