Merge pull request #93 from manics/dot-config

Load argument defaults from `.githubactivity.json`

Author: consideRatio

github_activity/cli.py

@@ -1,15 +1,28 @@
 import argparse
+import json
 import os
 import sys
 from subprocess import PIPE
 from subprocess import run
 
 from .git import _git_installed_check
+from .git import _git_toplevel_path
 from .github_activity import _parse_target
 from .github_activity import generate_activity_md
 from .github_activity import generate_all_activity_md
 
 DESCRIPTION = "Generate a markdown changelog of GitHub activity within a date window."
+
+# These defaults are managed by load_config_and_defaults so that they can be
+# overridden by a config file
+ARG_DEFAULTS = {
+    "heading-level": 1,
+    "include-issues": False,
+    "include-opened": False,
+    "strip-brackets": False,
+    "all": False,
+}
+
 parser = argparse.ArgumentParser(description=DESCRIPTION)
 parser.add_argument(
     "-t",
@@ -71,19 +84,19 @@
 )
 parser.add_argument(
     "--include-issues",
-    default=False,
+    default=None,
     action="store_true",
     help="Include Issues in the markdown output",
 )
 parser.add_argument(
     "--include-opened",
-    default=False,
+    default=None,
     action="store_true",
     help="Include a list of opened items in the markdown output",
 )
 parser.add_argument(
     "--strip-brackets",
-    default=False,
+    default=None,
     action="store_true",
     help=(
         "If True, strip any text between brackets at the beginning of the issue/PR title. "
@@ -92,7 +105,7 @@
 )
 parser.add_argument(
     "--heading-level",
-    default=1,
+    default=None,
     type=int,
     help=(
         """Base heading level to add when generating markdown.
@@ -113,7 +126,7 @@
 )
 parser.add_argument(
     "--all",
-    default=False,
+    default=None,
     action="store_true",
     help=("""Whether to include all the GitHub tags"""),
 )
@@ -127,6 +140,29 @@
 )
 
 
+def load_config_and_defaults(args):
+    """
+    Load .githubactivity.json from the Git top-level directory,
+    override unset args with values from .githubactivity.json,
+    and set defaults for remaining args.
+    """
+    config = {}
+    git_toplevel = _git_toplevel_path()
+    if git_toplevel:
+        try:
+            with open(os.path.join(git_toplevel, ".githubactivity.json")) as f:
+                config = json.load(f)
+        except FileNotFoundError:
+            pass
+
+    # Treat args as a dict
+    # https://docs.python.org/3/library/argparse.html#the-namespace-object
+    for argname in vars(args):
+        configname = argname.replace("_", "-")
+        if getattr(args, argname) is None:
+            setattr(args, argname, config.get(configname, ARG_DEFAULTS.get(configname)))
+
+
 def main():
     if not _git_installed_check():
         print("git is required to run github-activity", file=sys.stderr)
@@ -140,6 +176,8 @@ def main():
     if not args.target:
         args.target = args._target
 
+    load_config_and_defaults(args)
+
     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:

github_activity/git.py

@@ -8,3 +8,13 @@ def _git_installed_check():
         return True
     except subprocess.CalledProcessError:
         return False
+
+
+def _git_toplevel_path():
+    """Fetch the top-level of the local Git repository"""
+    cmd = ["git", "rev-parse", "--show-toplevel"]
+    try:
+        top = subprocess.check_output(cmd, stderr=subprocess.DEVNULL)
+        return top.strip().decode()
+    except subprocess.CalledProcessError:
+        return None

tests/resources/cli_no_target.githubactivity.json

@@ -0,0 +1,3 @@
+{
+  "heading-level": 5
+}

tests/test_cli.py

@@ -1,3 +1,5 @@
+import os
+import shutil
 from pathlib import Path
 from subprocess import run
 
@@ -43,6 +45,41 @@ def test_cli(tmpdir, file_regression, cmd, basename):
     file_regression.check(md, basename=basename, extension=".md")
 
 
+def test_cli_dot_config(tmp_path, monkeypatch, file_regression):
+    """Test that pyproject.toml config is loaded"""
+    cmd = "github-activity -s 2019-09-01 -u 2019-11-01 -o {path_output}"
+    basename = "cli_no_target_pyproject"
+
+    path_output = tmp_path / "out.md"
+
+    # We need to augment the repository with a custom .githubactivity.json
+    # but since a local git repo is only needed to get the origin a shallow
+    # clone is enough
+    run(
+        [
+            "git",
+            "clone",
+            "--depth=1",
+            "https://github.com/executablebooks/github-activity",
+            str(tmp_path / "repo"),
+        ],
+        check=True,
+    )
+    tests_dir = Path(__file__).parent
+    shutil.copyfile(
+        str(tests_dir / "resources" / "cli_no_target.githubactivity.json"),
+        str(tmp_path / "repo" / ".githubactivity.json"),
+    )
+
+    # cd into a subdirectory so we test the lookup of .githubactivity.json
+    monkeypatch.chdir(tmp_path / "repo" / "tests")
+
+    command = cmd.format(path_output=path_output)
+    run(command.split(), check=True)
+    md = path_output.read_text()
+    file_regression.check(md, basename=basename, extension=".md")
+
+
 def test_cli_nonexistent_branch(tmpdir):
     path_tmp = Path(tmpdir)
     path_output = path_tmp.joinpath("out.md")

tests/test_cli/cli_no_target_pyproject.md

@@ -0,0 +1,23 @@
+##### 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), [@betatim](https://github.com/betatim))
+- 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), [@consideRatio](https://github.com/consideRatio))
+- some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
+- 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), [@choldgraf](https://github.com/choldgraf))
+
+###### Contributors to this release
+
+The following people contributed discussions, new ideas, code and documentation contributions, and review.
+See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).
+
+([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 ([activity](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3Abetatim+updated%3A2019-09-01..2019-11-01&type=Issues)) | @choldgraf ([activity](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3Acholdgraf+updated%3A2019-09-01..2019-11-01&type=Issues)) | @consideRatio ([activity](https://github.com/search?q=repo%3Aexecutablebooks%2Fgithub-activity+involves%3AconsideRatio+updated%3A2019-09-01..2019-11-01&type=Issues))