Add show command

Author: zph

README.md

@@ -68,6 +68,7 @@ Commands:
   plan     Prepares the runbook for execution by injecting parameters.
   review   [Unimplemented] Entrypoint for reviewing runbook
   run      Run a notebook
+  show     Show runbook parameters and metadata
   version  Display version information about runbook
 ```
 

runbook/cli/__init__.py

@@ -13,6 +13,7 @@
     plan,
     review,
     run,
+    show,
     version,
 )
 
@@ -45,6 +46,7 @@ def cli(ctx, cwd):
 cli.add_command(review)
 cli.add_command(version)
 cli.add_command(list)
+cli.add_command(show)
 # cli.add_command(export)
 cli.name = "runbook"
 cli

runbook/cli/commands/__init__.py

@@ -8,4 +8,5 @@
 from runbook.cli.commands.plan import plan
 from runbook.cli.commands.review import review
 from runbook.cli.commands.run import run
+from runbook.cli.commands.show import show
 from runbook.cli.commands.version import version

runbook/cli/commands/show.py

@@ -0,0 +1,38 @@
+import click
+from rich.console import Console
+from rich.table import Table
+from runbook.cli.commands.plan import get_notebook_language
+from runbook.cli.validators import validate_runbook_file_path
+
+import papermill as pm
+
+
+@click.command()
+@click.argument(
+    "runbook", type=click.Path(file_okay=True), callback=validate_runbook_file_path
+)
+@click.pass_context
+def show(ctx, runbook):
+    """Show runbook parameters and metadata"""
+    console = Console()
+    inferred_params = pm.inspect_notebook(runbook)
+    notebook_language = get_notebook_language(runbook)
+
+    # Print runbook info with styling
+    console.print(f"\n[bold blue]Runbook:[/] {runbook}")
+    console.print(f"[bold blue]Language:[/] {notebook_language}\n")
+
+    # Create and populate parameters table
+    table = Table(show_header=True, header_style="bold magenta")
+    table.add_column("Parameter")
+    table.add_column("Default Value")
+    table.add_column("Type")
+    table.add_column("Help")
+
+    for param, value in inferred_params.items():
+        default = value["default"].rstrip(";")
+        typing = value["inferred_type_name"] or ""
+        help_text = value["help"] or ""
+        table.add_row(param, default, typing, help_text)
+
+    console.print(table)

tests/cli_test.py

@@ -56,6 +56,7 @@ def test_cli_help():
   plan     Prepares the runbook for execution by injecting parameters.
   review   [Unimplemented] Entrypoint for reviewing runbook
   run      Run a notebook
+  show     Show runbook parameters and metadata
   version  Display version information about runbook
 """
         assert result.output == output
@@ -160,3 +161,28 @@ def test_cli_lifecycle_to_run():
         # TODO: fix multiple singletons of ServerApp
         # result = invoker(runner, ["run", deno_template], dir)
         # assert result.exit_code == 0
+
+
+def test_cli_lifecycle_to_show():
+    runner = CliRunner()
+    with runner.isolated_filesystem() as dir:
+        result = invoker(runner, ["init"], dir)
+        assert result.exit_code == 0
+        result = invoker(runner, ["show", deno_template], dir)
+        assert result.exit_code == 0
+        assert (
+            result.output
+            == """
+Runbook: ./runbooks/binder/_template-deno.ipynb
+Language: typescript
+
+┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
+┃ Parameter            ┃ Default Value   ┃ Type     ┃ Help           ┃
+┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
+│ server               │ "main.xargs.io" │ string   │                │
+│ arg                  │ 1               │ number   │                │
+│ anArray              │ ["a", "b"]      │ string[] │ normally a / b │
+│ __RUNBOOK_METADATA__ │ {}              │ None     │                │
+└──────────────────────┴─────────────────┴──────────┴────────────────┘
+"""
+        )