default for list will show all unique container:tag

unless the user adds --short, in which case the tags will again be
combined into a single list alongside the container name.

Signed-off-by: vsoch <[email protected]>

Author: vsoch

CHANGELOG.md

@@ -17,6 +17,7 @@ The versions coincide with releases on pip. Only major versions will be released
  - adding namespaces to make module install, show, inspect easier (0.0.24)
  - added support for env section to render to bound environment file
  - added support for container features like gpu
+ - list defaults to showing modules/tags one per line, unless --short used
  - container url does not render in docs (0.0.23)
  - addition of tcl modules, removal of un-needed database (0.0.22)
  - first update of all containers, and bugfix to pull (0.0.21)

docs/getting_started/user-guide.rst

@@ -481,11 +481,39 @@ List
 ----
 
 Once a module is installed, you can use list to show installed modules (and versions).
+The default list will flatten out module names and tags into a single list
+to make it easy to copy paste:
 
 .. code-block:: console
 
     $ shpc list
-    python: 3.9.2-alpine, 3.9.2-slim
+        biocontainers/samtools:v1.9-4-deb_cv1
+                        python:3.9.2-alpine
+                        python:3.9.5-alpine
+                        python:3.9.2-slim
+                      dinosaur:fork
+                 vanessa/salad:latest
+                         salad:latest
+      ghcr.io/autamus/prodigal:latest
+      ghcr.io/autamus/samtools:latest
+        ghcr.io/autamus/clingo:5.5.0
+
+
+However, if you want a shorter version that shows multiple tags alongside
+each unique module name, just add ``--short``:
+
+.. code-block:: console
+
+    $ shpc list --short
+
+        biocontainers/samtools: v1.9-4-deb_cv1
+                        python: 3.9.5-alpine, 3.9.2-alpine, 3.9.2-slim
+                      dinosaur: fork
+                 vanessa/salad: latest
+                         salad: latest
+      ghcr.io/autamus/prodigal: latest
+      ghcr.io/autamus/samtools: latest
+        ghcr.io/autamus/clingo: 5.5.0
 
 
 Inspect

registry/vanessa/salad/container.yaml

@@ -8,7 +8,5 @@ tags:
   latest: sha256:e8302da47e3200915c1d3a9406d9446f04da7244e4995b7135afd2b79d4f63db
 aliases:
   salad: /code/salad
-features:
-  gpu: true
 env:
   maintainer: vsoch

shpc/client/__init__.py

@@ -84,6 +84,13 @@ def get_parser():
         "--names-only", help="omit versions", default=False, action="store_true"
     )
 
+    listing.add_argument(
+        "--short",
+        help="multiple tags per line for shorter length output.",
+        default=False,
+        action="store_true",
+    )
+
     # List local containers and collections
     inspect = subparsers.add_parser(
         "inspect", help="inspect an installed module image."

shpc/client/listing.py

@@ -14,4 +14,4 @@ def main(args, parser, extra, subparser):
         container_tech=args.container_tech,
     )
 
-    cli.list(args.pattern, args.names_only)
+    cli.list(args.pattern, args.names_only, short=args.short)

shpc/main/modules.py

@@ -187,12 +187,17 @@ def get(self, module_name):
             logger.exit("Found more than one sif in module folder.")
         return sif[0]
 
-    def list(self, pattern=None, names_only=False, out=None):
+    def list(self, pattern=None, names_only=False, out=None, short=False):
         """
         List installed modules.
         """
         self._list_modules(
-            self.settings.module_base, self.modulefile, pattern, names_only, out
+            self.settings.module_base,
+            self.modulefile,
+            pattern,
+            names_only,
+            out,
+            short=short,
         )
 
     def docgen(self, module_name, out=None):
@@ -240,7 +245,9 @@ def inspect(self, module_name):
         sif = self.get(module_name)
         return self._container.inspect(sif[0])
 
-    def _list_modules(self, base, filename, pattern=None, names_only=False, out=None):
+    def _list_modules(
+        self, base, filename, pattern=None, names_only=False, out=None, short=False
+    ):
         """A shared function to list modules or registry entries."""
         out = out or sys.stdout
         modules = self._get_module_lookup(base, filename, pattern)
@@ -253,8 +260,11 @@ def _list_modules(self, base, filename, pattern=None, names_only=False, out=None
         for module_name, versions in modules.items():
             if names_only:
                 out.write("%s\n" % module_name)
-            else:
+            elif short:
                 out.write("%s: %s\n" % (module_name.rjust(30), ", ".join(versions)))
+            else:
+                for version in versions:
+                    out.write("%s:%s\n" % (module_name.rjust(30), version))
 
     def _get_module_lookup(self, base, filename, pattern=None):
         """A shared function to get a lookup of installed modules or registry entries"""

shpc/tests/test_client.sh

@@ -68,6 +68,7 @@ echo
 echo "#### Testing list "
 runTest 0 $output shpc --settings-file $settings list --help
 runTest 0 $output shpc --settings-file $settings list
+runTest 0 $output shpc --settings-file $settings list --short
 runTest 0 $output shpc --settings-file $settings list salad
 
 echo