Simplify interface for calling nbconvert

Author: zph

runbook/cli/commands/create.py

@@ -11,15 +11,18 @@
     "-t",
     "--template",
     envvar="TEMPLATE",
-    default="./runbooks/binder/_template-python.ipynb",
+    default="./runbooks/binder/_template-deno.ipynb",
     type=click.Path(exists=True, file_okay=True),
     callback=validate_template,
 )
+
+# TODO: switch to language and template defaulting to Deno
+# based on operational experience at work
 @click.option(
     "-l",
     "--language",
     envvar="LANGUAGE",
-    default="./runbooks/binder/_template-python.ipynb",
+    default="deno",
     callback=validate_create_language,
 )
 @click.pass_context
@@ -36,9 +39,7 @@ def create(ctx, filename, template, language):
         )
     # TODO: remove hardcoding of folder outer name and rely on config file
     path.join("runbooks", "binder", filename)
-    # TODO: hide the nbconvert verbose output?
     argv = [
-        "--ClearOutputPreprocessor.enabled=True",
         template,
         "--to",
         "notebook",
@@ -48,7 +49,7 @@ def create(ctx, filename, template, language):
         path.join("runbooks", "binder"),
     ]
 
-    nbconvert_launch_instance(argv)
+    nbconvert_launch_instance(argv, clear_output=True)
 
     click.echo(
         click.style(

runbook/cli/commands/plan.py

@@ -12,8 +12,6 @@
 import papermill as pm
 
 
-# TODO: standardize ids in output files through custom processor
-# use something like ulid, we don't need full UUIDs
 @click.command()
 @click.argument(
     "input", type=click.Path(file_okay=True), callback=validate_runbook_file_path
@@ -57,7 +55,7 @@ def plan(ctx, input, embed, identifier="", params={}):
         # we make the simplifying assumption to show user and then treat inputs as potentially json
         for key, value in inferred_params.items():
             if key != RUNBOOK_METADATA:
-                default = value["default"].strip(";")
+                default = value["default"].rstrip(";")
                 typing = value["inferred_type_name"]
                 type_hint = ""
                 help_hint = ""
@@ -89,16 +87,13 @@ def plan(ctx, input, embed, identifier="", params={}):
     )
 
     argv = [
-        "--ClearOutputPreprocessor.enabled=True",
         "--inplace",
         full_output,
     ]
 
     # TODO: join the unified logic of create and plan
 
-    # TODO: hide the nbconvert verbose output?
-
-    nbconvert_launch_instance(argv)
+    nbconvert_launch_instance(argv, clear_output=True)
 
     for f in embed:
         shutil.copyfile(src=f, dst=f"{output_folder}/{path.basename(f)}")

runbook/cli/lib.py

@@ -20,8 +20,9 @@ def ts_id(length=10):
 
 
 # Suppresses nbconvert output
-def nbconvert_launch_instance(argv):
-    # Temporarily redirect stdout/stderr to suppress nbconvert output
+def nbconvert_launch_instance(argv, clear_output=True):
+    if clear_output:
+        argv.insert(0, "--ClearOutputPreprocessor.enabled=True")
     stdout = sys.stdout
     stderr = sys.stderr
     sys.stdout = StringIO()

runbook/cli/validators.py

@@ -4,6 +4,8 @@
 from pathlib import Path
 
 import click
+
+# TODO: use click prompt lib instead of questionary to avoid dependency
 import questionary
 
 
@@ -26,8 +28,10 @@ def validate_template(ctx, param, value):
 def validate_create_language(ctx, param, value):
     if value == "./runbooks/binder/_template-python.ipynb":
         return value
+    if value == "./runbooks/binder/_template-deno.ipynb":
+        return value
     if value in ["python", "deno"]:
-        return f"./runbooks/binder/_template-{value}"
+        return f"./runbooks/binder/_template-{value}.ipynb"
     else:
         raise click.BadOptionUsage("--language", "options are python or deno")