Uses fzf instead of pick; format with black and isort; prepare for 2.0.0

Author: kylebebak

README.md

@@ -3,11 +3,11 @@
 
 ![License](https://camo.githubusercontent.com/890acbdcb87868b382af9a4b1fac507b9659d9bf/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)
 
-__pick-git__ is a set of command line tools for leveraging thoughtbot's [pick](https://github.com/calleerlandsson/pick) to turbocharge your Git workflow.
+__pick-git__ is a set of command line tools for leveraging [fzf](https://github.com/junegunn/fzf) to turbocharge your Git workflow.
 
 Git can be a bit of a pain, especially when passing branches or commit hashes as args. Big projects have lots of branches and tons of commits. Finding and copying commit hashes to compare commits, for example, is awkward and slow.
 
-`pick`, however, was literally born for jobs like this. __pick-git__ uses `pick` to make working with branches, commits and files in your project's repo a breeze.
+`fzf`, however, was literally born for jobs like this. __pick-git__ uses `fzf` to make working with branches, commits and files in your project's repo a breeze.
 
 It's installable via `pip` and works with Python 2/3.
 
@@ -19,7 +19,7 @@ pip install pick-git
 
 
 ## Dependencies
-- [pick](https://github.com/calleerlandsson/pick)
+- [fzf](https://github.com/junegunn/fzf)
 - [pyperclip](https://github.com/asweigart/pyperclip) (optional, and anyway it's automatically included if you install with `pip`)
 
 
@@ -34,7 +34,7 @@ I have `ghp` aliased to `pick-git --function commit`. The function argument is o
 
 `gd` is a shortcut I have that resolves to `git diff`. The `-b` flag allows me to pick both commits and compare them, instead of just picking one and comparing it with HEAD.
 
-At the end the final command that was invoked, `gd 28faaf7 4750072`, was printed to the console. I was able to find two commits and compare them very quickly and with very few keystrokes. __Even if these commits had been in a much bigger project and were months old__, pick's fuzzy select would have found them in no time as long as my commit messages were descriptive.
+At the end the final command that was invoked, `gd 28faaf7 4750072`, was printed to the console. I was able to find two commits and compare them very quickly and with very few keystrokes. __Even if these commits had been in a much bigger project and were months old__, fzf's fuzzy select would have found them in no time as long as my commit messages were descriptive.
 
 
 ### Shortcuts to pick-git Public Functions
@@ -92,7 +92,7 @@ Run `pick-git -h`.
 
 
 ## Contributing
-The "primitives" for the package are defined in `pick_git/core.py` and are listed below. These are the functions that actually invoke `pick`. If you think of other useful primitives please fork the repo and submit a pull request.
+The "primitives" for the package are defined in `pick_git/core.py` and are listed below. These are the functions that actually invoke `fzf`. If you think of other useful primitives please fork the repo and submit a pull request.
 
 - `pick_branch`
 - `pick_commit`
@@ -117,7 +117,3 @@ If anyone has ideas I'd love to hear them.
 
 ## License
 This code is licensed under the [MIT License](https://opensource.org/licenses/MIT).
-
-
-## Thanks
-To Calle Erlandsson and thoughtbot for writing pick =)

pick_git/command_line.py

@@ -1,33 +1,51 @@
-import subprocess
 import argparse
+import subprocess
 import sys
 
-from .pg import PG
 from .helpers import PGPublicMethodMixin
+from .pg import PG
 
+your_version = "2.0.0"
 
-parser = argparse.ArgumentParser(description='Invoke a pick-git function.')
+parser = argparse.ArgumentParser(description="Invoke a pick-git function.")
 
-parser.add_argument('--function', required=True,
-                    help='Specify public function to invoke. This argument is required. See README for descriptions of public functions.')
+parser.add_argument(
+    "--function",
+    required=True,
+    help="Specify public function to invoke. This argument is required. See README for descriptions of public functions.",
+)
 
-parser.add_argument('-b', '--both', action='store_true',
-                    help='Pick both branches, tags, commits, or files, where appropriate.')
-parser.add_argument('-S', '--show', action='store_true',
-                    help='Show file instead of diffing it, where appropriate.')
-parser.add_argument('-s', '--staged', action='store_true',
-                    help='Diff staged files, where appropriate.')
-parser.add_argument('-d', '--detailed', action='store_true',
-                    help='Show detail of commits instead of just count, when invoking branch_compare.')
-parser.add_argument('-n', '--nocopy', dest='no_copy', action='store_true',
-                    help='Disable automatic copying of branch names, commit hashes, file names, etc.')
+parser.add_argument(
+    "-b",
+    "--both",
+    action="store_true",
+    help="Pick both branches, tags, commits, or files, where appropriate.",
+)
+parser.add_argument(
+    "-S",
+    "--show",
+    action="store_true",
+    help="Show file instead of diffing it, where appropriate.",
+)
+parser.add_argument("-s", "--staged", action="store_true", help="Diff staged files, where appropriate.")
+parser.add_argument(
+    "-d",
+    "--detailed",
+    action="store_true",
+    help="Show detail of commits instead of just count, when invoking branch_compare.",
+)
+parser.add_argument(
+    "-n",
+    "--nocopy",
+    dest="no_copy",
+    action="store_true",
+    help="Disable automatic copying of branch names, commit hashes, file names, etc.",
+)
 
-parser.add_argument('--shell',
-                    help='Specify shell invoked interactively when `execute` is invoked.')
-parser.add_argument('--rcfile',
-                    help='Specify startup file invoked by shell when `execute` is invoked.')
+parser.add_argument("--shell", help="Specify shell invoked interactively when `execute` is invoked.")
+parser.add_argument("--rcfile", help="Specify startup file invoked by shell when `execute` is invoked.")
 
-parser.add_argument('args', help='Pass other args to function.', nargs='*')
+parser.add_argument("args", help="Pass other args to function.", nargs="*")
 
 
 def main():
@@ -36,12 +54,25 @@ def main():
 
     http://python-packaging.readthedocs.io/en/latest/command-line-scripts.html#the-console-scripts-entry-point
     """
+    if len(sys.argv) > 1 and (sys.argv[1] == "-v" or sys.argv[1] == "--version"):
+        print("pick-git version {}".format(your_version))
+        sys.exit(0)
+
     args = parser.parse_args()
-    kwargs = {name: args.__getattribute__(name) for name in [
-        'both', 'show', 'staged', 'detailed', 'no_copy', 'shell', 'rcfile',
-    ]}
-    if not subprocess.call(['which', 'pick']) == 0:
-        print("pick isn't installed! exiting...")
+    kwargs = {
+        name: args.__getattribute__(name)
+        for name in [
+            "both",
+            "show",
+            "staged",
+            "detailed",
+            "no_copy",
+            "shell",
+            "rcfile",
+        ]
+    }
+    if not subprocess.call(["which", "fzf"]) == 0:
+        print("fzf isn't installed! exiting...")
         sys.exit()
     pg = PG(**kwargs)
     if not hasattr(PGPublicMethodMixin, args.function):

pick_git/core.py

@@ -1,14 +1,13 @@
+import os
 import subprocess
 import sys
-import os
-from subprocess import STDOUT, PIPE
 from functools import wraps
+from subprocess import PIPE
 
 
 def repository_root():
-    """Return full path to root of repo.
-    """
-    return subprocess.check_output(['git', 'rev-parse', '--show-toplevel']).strip().decode('utf-8')
+    """Return full path to root of repo."""
+    return subprocess.check_output(["git", "rev-parse", "--show-toplevel"]).strip().decode("utf-8")
 
 
 def cd_repository_root():
@@ -20,20 +19,18 @@ def cd_repository_root():
 
 
 def current_branch():
-    """Return name of currently checked out branch.
-    """
-    return subprocess.check_output(['git', 'rev-parse', '--abbrev-ref', 'HEAD']).strip().decode('utf-8')
+    """Return name of currently checked out branch."""
+    return subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"]).strip().decode("utf-8")
 
 
 def add_new_line(b):
-    """To end of `str` or `bytes` instance.
-    """
+    """To end of `str` or `bytes` instance."""
     if sys.version_info < (3, 0, 0):
-        if b[-1] != '\n':
-            b += '\n'
+        if b[-1] != "\n":
+            b += "\n"
     else:
-        if b[-1:] != bytes('\n', 'utf-8'):
-            b += bytes('\n', 'utf-8')
+        if b[-1:] != bytes("\n", "utf-8"):
+            b += bytes("\n", "utf-8")
     return b
 
 
@@ -47,87 +44,84 @@ def exit_on_keyboard_interrupt(f):
 
     See here: https://stackoverflow.com/questions/39499959/terminating-a-subprocess-with-keyboardinterrupt/39503654
     """
+
     @wraps(f)
     def wrapper(*args, **kwargs):
-        raise_exception = kwargs.pop('raise_exception', False)
+        raise_exception = kwargs.pop("raise_exception", False)
         try:
             return f(*args, **kwargs)
         except KeyboardInterrupt:
             if not raise_exception:
                 sys.exit()
             raise KeyboardInterrupt
+
     return wrapper
 
 
 @exit_on_keyboard_interrupt
 def pick_branch(*args):
-    """Pick a branch, local or remote.
-    """
-    branches = subprocess.check_output(('git', 'branch', '-a') + args)
-    p = subprocess.Popen(['pick'], stdin=PIPE, stdout=PIPE, stderr=STDOUT)
+    """Pick a branch, local or remote."""
+    branches = subprocess.check_output(("git", "branch", "-a") + args)
+    p = subprocess.Popen(["fzf"], stdin=PIPE, stdout=PIPE)
     branch = p.communicate(input=branches)[0]
     if not branch:
         raise KeyboardInterrupt
-    return branch.split()[-1].decode('utf-8')
+    return branch.split()[-1].decode("utf-8")
 
 
 @exit_on_keyboard_interrupt
 def pick_tag(*args):
-    """Pick a local tag.
-    """
-    branches = subprocess.check_output(('git', 'tag', '-l') + args)
-    p = subprocess.Popen(['pick'], stdin=PIPE, stdout=PIPE, stderr=STDOUT)
+    """Pick a local tag."""
+    branches = subprocess.check_output(("git", "tag", "-l") + args)
+    p = subprocess.Popen(["fzf"], stdin=PIPE, stdout=PIPE)
     branch = p.communicate(input=branches)[0]
     if not branch:
         raise KeyboardInterrupt
-    return branch.split()[-1].decode('utf-8')
+    return branch.split()[-1].decode("utf-8")
 
 
 @exit_on_keyboard_interrupt
 def pick_commit(*args):
-    """Pick a commit hash.
-    """
-    commits = subprocess.check_output(('git', 'log', "--pretty=format:%h %ad | %s%d [%an]", '--date=short') + args)
-    p = subprocess.Popen(['pick'], stdin=PIPE, stdout=PIPE, stderr=STDOUT)
+    """Pick a commit hash."""
+    commits = subprocess.check_output(("git", "log", "--pretty=format:%h %ad | %s%d [%an]", "--date=short") + args)
+    p = subprocess.Popen(["fzf"], stdin=PIPE, stdout=PIPE)
     commit = p.communicate(input=add_new_line(commits))[0]
     if not commit:
         raise KeyboardInterrupt
-    return commit.split()[0].decode('utf-8')
+    return commit.split()[0].decode("utf-8")
 
 
 @exit_on_keyboard_interrupt
 def pick_commit_reflog(*args):
-    """Pick a commit hash from the reflog.
-    """
-    commits = subprocess.check_output(('git', 'reflog', '--date=short') + args)
-    p = subprocess.Popen(['pick'], stdin=PIPE, stdout=PIPE, stderr=STDOUT)
+    """Pick a commit hash from the reflog."""
+    commits = subprocess.check_output(("git", "reflog", "--date=short") + args)
+    p = subprocess.Popen(["fzf"], stdin=PIPE, stdout=PIPE)
     commit = p.communicate(input=add_new_line(commits))[0]
     if not commit:
         raise KeyboardInterrupt
-    return commit.split()[0].decode('utf-8')
+    return commit.split()[0].decode("utf-8")
 
 
 @exit_on_keyboard_interrupt
 def pick_modified_file(*args):
     """Pick a file whose state differs between branches or commits, which are
     passed in `args`. `args` can contain between 0 and 2 elements.
     """
-    files = subprocess.check_output(('git', 'diff', '--name-only') + args)
-    p = subprocess.Popen(['pick'], stdin=PIPE, stdout=PIPE, stderr=STDOUT)
+    files = subprocess.check_output(("git", "diff", "--name-only") + args)
+    p = subprocess.Popen(["fzf"], stdin=PIPE, stdout=PIPE)
     file = p.communicate(input=files)[0]
     if not file:
         raise KeyboardInterrupt
-    return file.strip().decode('utf-8')
+    return file.strip().decode("utf-8")
 
 
 @exit_on_keyboard_interrupt
 def pick_file(*args):
-    """Pick a file from the index.
-    """
+    """Pick a file from the index."""
     branch = current_branch()
-    files = subprocess.check_output(('git', 'ls-tree', '-r', branch, '--name-only') + args)
-    p = subprocess.Popen(['pick'], stdin=PIPE, stdout=PIPE, stderr=STDOUT)
+    files = subprocess.check_output(("git", "ls-tree", "-r", branch, "--name-only") + args)
+    p = subprocess.Popen(["fzf"], stdin=PIPE, stdout=PIPE)
     file = p.communicate(input=files)[0]
     if not file:
         raise KeyboardInterrupt
-    return file.strip().decode('utf-8')
+    return file.strip().decode("utf-8")