Implement 'bak list' (#36)

Closes #11

Author: ChanceNCounter

README.md

@@ -11,7 +11,7 @@ The problem, of course, is remembering to delete that file when you're finished.
 **bak**'s goal is simply to obviate this process. Using **bak**, you'll be able to manage your bakfiles with four simple commands:
 
 `bak my_file` - Create a bakfile in a configured location (default: XDG_DATA_HOME/bak/bakfiles, or XDG's default location)  
-`bak up my_file` - Overwrite current `my_file.bak`, rather than creating a second .bakfile. 
+`bak up my_file` - Overwrite current `my_file.bak`, rather than creating a second .bakfile.  
 `bak down my_file` - Deletes `my_file` and restores it from `my_file.bak`  
 `bak off my_file` - Deletes `my_file.bak`, confirming by default (`bak off -q` to suppress)
 
@@ -25,29 +25,26 @@ Don't worry, they're easy to remember after a minute:
 All of **bak**'s commands will disambiguate between multiple copies of the same file. In other words, you can `bak my_thing.txt` as many times as you want, until you're finished working, if you'd prefer to keep multiples instead of using `bak up`. At the moment, all you've got to go by are timestamps when it asks you to pick a .bakfile, but this will improve.
 
 ## Additional commands and flags
+
 `bak down --keep my_file` - Restores from .bakfile, does not delete .bakfile  
 `bak diff my_file` Compare a .bakfile using `diff` (will become configurable)  
-`bak show my_file` View a .bakfile in $PAGER  
-`bak show --using exec my_file` View a .bakfile using `exec`  (alias `--in`)
+`bak list`/`bak list my_file` - List all .bakfiles, or just `my_file`'s  
+`bak open my_file` View a .bakfile in $PAGER  
+`bak open --using exec my_file` View a .bakfile using `exec`  (alias `--in`)
 
 examples:
 
-        bak show --using cat my_file.json
-        bak show --in nvim my_file.json
+        bak open --using cat my_file.json
+        bak open --in nvim my_file.json
+
 `bak get-bak my_file` Get the abspath of a .bakfile, in case, for some reason, you want to pipe it somewhere
 
 example (for illustrative purposes; use 'bak diff' instead):
 
-    diff $(bak get-bak my_file.json) my_file.json
-
-## Advanced features (Not yet implemented as of Oct. 28, 2020)
-**bak** is also slated to support a number of flags, as well as rich output, such as:
-
-`bak list` - List all .bakfiles, with a bit of metadata to help with disambiguation  
-`bak list my_file` - List all .bakfiles *of the specified file*, with metadata  
+    diff `bak get-bak my_file.json)` my_file.json
 
-## Current state (updated Oct. 31, 2020)
-This is a very pre-alpha version, as in, this is a spaghetti proof-of-concept. Perhaps ~~5-6~~ 12-15 hours have been spent on development so far. As such, it's only "working" in the strictest sense.
+## Current state (updated Jan. 20, 2020)
+This is a very pre-alpha version, as in, this is a spaghetti proof-of-concept. Perhaps ~~5-6~~ ~~12-15~~ 20 hours have been spent on development so far. As such, it's only "working" in the strictest sense.
 
 At the moment, **bak** stores its database and your bakfiles in `$XDG_DATA_HOME/bak`. If `$XDG_DATA_HOME` is not set, its specified default is used, and your stuff ends up in `~/.local/share/bak`.
 

bak/__main__.py

@@ -4,7 +4,6 @@
 
 import click
 from click_default_group import DefaultGroup
-import config
 
 from bak import commands
 
@@ -72,16 +71,14 @@ def bak_off(filename, quietly):
         # TODO better output here
         click.echo("Operation cancelled or failed.")
 
-
-@bak.command("show", help="View a .bakfile in an external program")
-@click.option("--using", "--in",
+@bak.command("open", help="View or edit a .bakfile in an external program")
+@click.option("--using", "--in", "--with",
               help="Program to open (default: $PAGER or less)",
-              required=False)
+              required=False, hidden=True)
 @click.argument("filename", required=True, type=click.Path(exists=True))
 def bak_print(filename, using):
     commands.bak_print_cmd(filename, using)
 
-
 @bak.command("get-bak",
              help="Outputs the real path of a .bakfile. "
              "Useful for piping, and not much else.",
@@ -93,14 +90,28 @@ def bak_get(to_where_you_once_belonged):
     commands.bak_getfile_cmd(to_where_you_once_belonged)
 
 
-@bak.command("diff")
-@click.option("--using", "--in",
+@bak.command("diff",
+             help="diff a file against its .bakfile")
+@click.option("--using", "--with",
               help="Program to use instead of system diff",
               required=False)
 @click.argument("filename", required=True, type=click.Path(exists=True))
 def bak_diff(filename, using):
     commands.bak_diff_cmd(filename, command=using)
-
+    
+@bak.command("list",
+             help="List all .bakfiles, or a particular file's")
+@click.option("--relpaths",
+              help="Display relative paths instead of abspaths",
+              required=False,
+              is_flag=True,
+              default=commands.bak_list_relpaths)
+@click.argument("filename",
+            #   help="List a particular file's .bakfiles",
+              required=False,
+              type=click.Path(exists=True))
+def bak_list(relpaths, filename):
+    commands.show_bak_list(filename=filename or None, relative_paths=relpaths)
 
 if __name__ == "__main__":
     bak()