✨ ENH: Auto-detecting the target (#45)

Co-authored-by: Erik Sundell <erik.i.sundell@gmail.com>

Author: choldgraf

.github/workflows/tests.yaml

@@ -19,9 +19,10 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -e .[testing]
-    # CURRENTLY NOT TESTING because it throws an API token error
-    # - name: Run tests
-    #   run: pytest
+    - name: Run tests
+      env:
+        GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: pytest
 
   docs:
 

README.md

@@ -26,7 +26,7 @@ The easiest way to use `github-activity` to generate activity markdown is to use
 the command-line interface. It takes the following form:
 
 ```
-github-activity <org>/<repo> --since <date or ref> --until <date or ref>
+github-activity [<org>/<repo>] --since <date or ref> --until <date or ref>
 ```
 
 See [the github-activity documentation](https://github-activity.readthedocs.io)

docs/index.md

@@ -28,9 +28,12 @@ The easiest way to use `github-activity` to generate activity markdown is to use
 the command-line interface. It takes the following form:
 
 ```
-github-activity <org>/<repo> --since <date or ref> --until <date or ref>
+github-activity [<org>/<repo>] --since <date or ref> --until <date or ref>
 ```
 
+The `[<org>/<repo>]` argument is **optional**.
+If you do not give it, then `github-activity` will attempt to infer this value by running `git remote -v` and using either `upstream` or `origin` (preferring `upstream` if both are available).
+
 The (optional) arguments in `--since` (or `-s`) and `--until` (or `-u`) can either be
 a date, or a ref (such as a commit hash or tag). `github-activity` will pull the activity
 between the dates corresponding to these values.

github_activity/cli.py

@@ -1,19 +1,24 @@
 import argparse
 import os
 import sys
+from subprocess import run, PIPE
 
-from .github_activity import generate_activity_md
+from .github_activity import generate_activity_md, _parse_target
 from .git import _git_installed_check
 
 DESCRIPTION = "Generate a markdown changelog of GitHub activity within a date window."
 parser = argparse.ArgumentParser(description=DESCRIPTION)
 parser.add_argument(
-    "target",
+    "-t",
+    "--target",
+    nargs="?",
+    default=None,
     help="""The GitHub organization/repo for which you want to grab recent issues/PRs.
     Can either be *just* an organization (e.g., `jupyter`), or a combination
     organization and repo (e.g., `jupyter/notebook`). If the former, all
     repositories for that org will be used. If the latter, only the specified
-    repository will be used. Can also be a GitHub URL to an organization or repo.""",
+    repository will be used. Can also be a GitHub URL to an organization or repo. If
+    None, the org/repo will attempt to be inferred from `git remote -v`.""",
 )
 parser.add_argument(
     "-s",
@@ -100,9 +105,7 @@
     "--branch",
     "-b",
     default=None,
-    help=(
-        """The branch or reference name to filter pull requests by"""
-    ),
+    help=("""The branch or reference name to filter pull requests by"""),
 )
 
 
@@ -111,8 +114,41 @@ def main():
         print("git is required to run github-activity", file=sys.stderr)
         sys.exit(1)
 
-    args = parser.parse_args(sys.argv[1:])
+    args, unknown = parser.parse_known_args()
+    # If we have unknown, it is the target
+    # TODO: this feels sub-optimal, we should be able to just treat positional args
+    # as optional.
+    if unknown and not args.target:
+        args.target = unknown[0]
+
     tags = args.tags.split(",") if args.tags is not None else args.tags
+    # Automatically detect the target from remotes if we haven't had one passed.
+    if not args.target:
+        err = "Could not automatically detect remote, and none was given."
+        try:
+            out = run("git remote -v".split(), stdout=PIPE)
+            remotes = out.stdout.decode().split("\n")
+            remotes = [ii for ii in remotes if ii]
+            remotes = {
+                ii.split("\t")[0]: ii.split("\t")[1].split()[0] for ii in remotes
+            }
+            if "upstream" in remotes:
+                ref = remotes["upstream"]
+            elif "origin" in remotes:
+                ref = remotes["origin"]
+            else:
+                ref = None
+            if not ref:
+                raise ValueError(err)
+
+            org, repo = _parse_target(ref)
+            if repo:
+                args.target = f"{org}/{repo}"
+            else:
+                args.target = f"{org}"
+        except Exception:
+            raise ValueError(err)
+
     md = generate_activity_md(
         args.target,
         since=args.since,
@@ -124,7 +160,7 @@ def main():
         include_opened=bool(args.include_opened),
         strip_brackets=bool(args.strip_brackets),
         heading_level=args.heading_level,
-        branch=args.branch
+        branch=args.branch,
     )
     if not md:
         return

github_activity/git.py

@@ -1,5 +1,6 @@
 import subprocess
 
+
 def _git_installed_check():
     cmd = ["git", "--help"]
     try:

github_activity/github_activity.py

@@ -6,6 +6,7 @@
 import sys
 import urllib
 from pathlib import Path
+from subprocess import run, PIPE
 
 from .graphql import GitHubGraphQlQuery
 from .cache import _cache_data
@@ -22,7 +23,7 @@
     },
     "enhancement": {
         "tags": ["enhancement", "enhancements"],
-        "pre": ["NEW", "ENH", "ENHANCEMENT", "IMPROVE"],
+        "pre": ["ENH", "ENHANCEMENT", "IMPROVE", "IMP"],
         "description": "Enhancements made",
     },
     "bug": {
@@ -149,7 +150,7 @@ def generate_activity_md(
     include_opened=False,
     strip_brackets=False,
     heading_level=1,
-    branch=None
+    branch=None,
 ):
     """Generate a markdown changelog of GitHub activity within a date window.
 
@@ -258,7 +259,9 @@ def generate_activity_md(
 
     # Filter the PRs by branch (or ref) if given
     if branch is not None:
-        index_names = data[ (data["kind"] == "pr") & (data["baseRefName"] != branch)].index
+        index_names = data[
+            (data["kind"] == "pr") & (data["baseRefName"] != branch)
+        ].index
         data.drop(index_names, inplace=True)
         if data.empty:
             return
@@ -410,7 +413,11 @@ def generate_activity_md(
     changelog_url = f"https://github.com/{org}/{repo}/compare/{since_ref}...{until_ref}"
 
     # Build the Markdown
-    md = [f"{extra_head}# {since}...{until}", "", f"([full changelog]({changelog_url}))"]
+    md = [
+        f"{extra_head}# {since}...{until}",
+        "",
+        f"([full changelog]({changelog_url}))",
+    ]
     for kind, info in prs.items():
         if len(info["md"]) > 0:
             md += [""]
@@ -480,8 +487,21 @@ def extract_comments(comments):
 
 
 def _parse_target(target):
+    """
+    Returns (org, repo) based on input such as:
+
+    - executablebooks
+    - executablebooks/jupyter-book
+    - http(s)://github.com/executablebooks
+    - http(s)://github.com/executablebooks/jupyter-book(.git)
+    - git@github.com:executablebooks/jupyter-book(.git)
+    """
     if target.startswith("http"):
         target = target.split("github.com/")[-1]
+    elif "@github.com:" in target:
+        target = target.split("@github.com:")[-1]
+    if target.endswith(".git"):
+        target = target.rsplit(".git", 1)[0]
     parts = target.split("/")
     if len(parts) == 2:
         org, repo = parts
@@ -530,8 +550,6 @@ def _get_datetime_from_git_ref(org, repo, ref):
 
 def _get_latest_tag(org, repo):
     """Return the latest tag name for a given repository."""
-    response = requests.get(f"https://api.github.com/repos/{org}/{repo}/git/refs/tags")
-    response.raise_for_status()
-    tags = response.json()
-    latest_tag = list(tags)[-1]
-    return latest_tag["ref"].split("/tags/")[-1]
+    out = run("git describe --tags".split(), stdout=PIPE)
+    tag = out.stdout.decode().rsplit("-", 2)[0]
+    return tag

tests/test_cli.py

@@ -3,6 +3,7 @@
 
 
 def test_cli(tmpdir, file_regression):
+    """The output of all file_regressions should be the same, testing diff opts."""
     path_tmp = Path(tmpdir)
     path_output = path_tmp.joinpath("out.md")
 
@@ -11,29 +12,36 @@ def test_cli(tmpdir, file_regression):
 
     # CLI with URL
     cmd = f"github-activity {url} -s 2019-09-01 -u 2019-11-01 -o {path_output}"
-    out = run(cmd.split(), check=True)
+    run(cmd.split(), check=True)
     md = path_output.read_text()
-    file_regression.check(md, extension=".md")
+    file_regression.check(md, basename="cli_w_url", extension=".md")
 
     # CLI with parts
     cmd = f"github-activity {org}/{repo} -s 2019-09-01 -u 2019-11-01 -o {path_output}"
-    out = run(cmd.split(), check=True)
+    run(cmd.split(), check=True)
     md = path_output.read_text()
-    file_regression.check(md, extension=".md")
+    file_regression.check(md, basename="cli_w_parts", extension=".md")
 
     # CLI with default branch
     cmd = f"github-activity {org}/{repo} -s 2019-09-01 -u 2019-11-01 -o {path_output} -b master"
-    out = run(cmd.split(), check=True)
+    run(cmd.split(), check=True)
     md = path_output.read_text()
-    file_regression.check(md, extension=".md")
+    file_regression.check(md, basename="cli_def_branch", extension=".md")
 
     # CLI with non-existent branch
     cmd = f"github-activity {org}/{repo} -s 2019-09-01 -u 2019-11-01 -o {path_output} -b foo"
-    out = run(cmd.split(), check=True)
+    run(cmd.split(), check=True)
     md = path_output.read_text()
     assert "Contributors to this release" in md
     assert "Merged PRs" not in md
 
+    # CLI with no target
+    cmd = f"github-activity -s 2019-09-01 -u 2019-11-01 -o {path_output}"
+    run(cmd.split(), check=True)
+    md = path_output.read_text()
+    file_regression.check(md, basename="cli_no_target", extension=".md")
+
+
 def test_pr_split(tmpdir, file_regression):
     """Test that PRs are properly split by tags/prefixes."""
     path_tmp = Path(tmpdir)
@@ -43,7 +51,7 @@ def test_pr_split(tmpdir, file_regression):
 
     # This release range covers some PRs with tags, and some with prefixes
     cmd = f"github-activity {url} -s v0.7.1 -u v0.7.3 -o {path_output}"
-    out = run(cmd.split(), check=True)
+    run(cmd.split(), check=True)
     md = path_output.read_text()
     md = md.split("## Contributors to this release")[0]
     file_regression.check(md, extension=".md")

tests/test_cli/test_cli.md tests/test_cli/cli_def_branch.mdtests/test_cli/test_cli.md renamed to tests/test_cli/cli_def_branch.md

@@ -4,14 +4,14 @@
 
 ## Merged PRs
 
-* defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf))
-* updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
-* fixing link to changelog with refs [#11](https://github.com/executablebooks/github-activity/pull/11) ([@choldgraf](https://github.com/choldgraf))
-* adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf))
-* some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf))
-* Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio))
-* adding authentication information [#2](https://github.com/executablebooks/github-activity/pull/2) ([@choldgraf](https://github.com/choldgraf))
-* Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio))
+- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf))
+- updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
+- fixing link to changelog with refs [#11](https://github.com/executablebooks/github-activity/pull/11) ([@choldgraf](https://github.com/choldgraf))
+- adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf))
+- some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio))
+- adding authentication information [#2](https://github.com/executablebooks/github-activity/pull/2) ([@choldgraf](https://github.com/choldgraf))
+- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio))
 
 ## Contributors to this release
 

tests/test_cli/cli_no_target.md

@@ -0,0 +1,20 @@
+# master@{2019-09-01}...master@{2019-11-01}
+
+([full changelog](https://github.com/executablebooks/github-activity/compare/479cc4b2f5504945021e3c4ee84818a10fabf810...ed7f1ed78b523c6b9fe6b3ac29e834087e299296))
+
+## Merged PRs
+
+- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf))
+- updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
+- fixing link to changelog with refs [#11](https://github.com/executablebooks/github-activity/pull/11) ([@choldgraf](https://github.com/choldgraf))
+- adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf))
+- some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio))
+- adding authentication information [#2](https://github.com/executablebooks/github-activity/pull/2) ([@choldgraf](https://github.com/choldgraf))
+- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio))
+
+## Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/executablebooks/github-activity/graphs/contributors?from=2019-09-01&to=2019-11-01&type=c))
+
+[@betatim](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3Abetatim+updated%3A2019-09-01..2019-11-01&type=Issues) | [@choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3Acholdgraf+updated%3A2019-09-01..2019-11-01&type=Issues) | [@consideRatio](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3AconsideRatio+updated%3A2019-09-01..2019-11-01&type=Issues)

tests/test_cli/cli_w_parts.md

@@ -0,0 +1,20 @@
+# master@{2019-09-01}...master@{2019-11-01}
+
+([full changelog](https://github.com/executablebooks/github-activity/compare/479cc4b2f5504945021e3c4ee84818a10fabf810...ed7f1ed78b523c6b9fe6b3ac29e834087e299296))
+
+## Merged PRs
+
+- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf))
+- updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
+- fixing link to changelog with refs [#11](https://github.com/executablebooks/github-activity/pull/11) ([@choldgraf](https://github.com/choldgraf))
+- adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf))
+- some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio))
+- adding authentication information [#2](https://github.com/executablebooks/github-activity/pull/2) ([@choldgraf](https://github.com/choldgraf))
+- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio))
+
+## Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/executablebooks/github-activity/graphs/contributors?from=2019-09-01&to=2019-11-01&type=c))
+
+[@betatim](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3Abetatim+updated%3A2019-09-01..2019-11-01&type=Issues) | [@choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3Acholdgraf+updated%3A2019-09-01..2019-11-01&type=Issues) | [@consideRatio](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3AconsideRatio+updated%3A2019-09-01..2019-11-01&type=Issues)