cli improvements

Author: rmorshea

docs/Dockerfile

@@ -23,7 +23,7 @@ ADD MANIFEST.in ./
 ADD README.md ./
 
 RUN pip install -e .[all]
-RUN python -m idom install victory semantic-ui-react @material-ui/core
+RUN python -m idom client install victory semantic-ui-react @material-ui/core
 
 # Build the Docs
 # --------------

docs/source/examples.rst

@@ -57,7 +57,7 @@ Simply install your javascript library of choice using the ``idom`` CLI:
 
 .. code-block:: bash
 
-    idom install victory
+    idom client install victory
 
 Then import the module with :class:`~idom.widgets.utils.Module`:
 

docs/source/examples/super_simple_chart.py

@@ -3,6 +3,9 @@
 import idom
 
 
+# we use this to make writing our React code a bit easier
+idom.install("htm")
+
 path_to_source_file = Path(__file__).parent / "super_simple_chart.js"
 ssc = idom.Module("super-simple-chart", source_file=path_to_source_file)
 

docs/source/javascript-components.rst

@@ -38,7 +38,7 @@ using the ``idom`` CLI:
 
 .. code-block:: bash
 
-    idom install @material-ui/core
+    idom client install @material-ui/core
 
 Or at runtime with :func:`idom.client.module.install` (this is useful if you're working
 in a REPL or Jupyter Notebook):

noxfile.py

@@ -142,4 +142,4 @@ def test_docs(session: Session) -> None:
 
 def install_idom_dev(session: Session, extras: str = "stable") -> None:
     session.install("-e", f".[{extras}]")
-    session.run("idom", "restore")
+    session.run("idom", "client", "restore")

requirements/pkg-deps.txt

@@ -7,3 +7,4 @@ jsonpatch >=1.26
 typer >=0.3.2
 click-spinner >=0.1.10
 fastjsonschema >=2.14.5
+rich >=9.13.0

src/idom/cli.py

@@ -1,31 +1,58 @@
 from typing import List
 
 import typer
+from rich.console import Console
+from rich.table import Table
 
 import idom
 from idom.client import manage as manage_client
 
 
 main = typer.Typer()
-show = typer.Typer()
-main.add_typer(show, name="show", short_help="Display information about IDOM")
+console = Console()
 
+# --- Subcommands ---
+client = typer.Typer(name="client", short_help="Manage IDOM's built-in client")
+show = typer.Typer(name="show", short_help="Display information about IDOM")
+main.add_typer(client)
+main.add_typer(show)
 
-@main.command()
+
+@client.command()
 def install(packages: List[str]) -> None:
-    """Install a Javascript package from NPM"""
-    manage_client.build(packages)
+    """Install a Javascript package from NPM into the client"""
+    manage_client.build(packages, clean_build=False)
     return None
 
 
-@main.command()
-def restore(clean_build: bool = True) -> None:
-    """Return to a fresh install of IDOM's client"""
+@client.command()
+def rebuild(clean: bool = False) -> None:
+    """Rebuild the client (keeps currently installed packages by default)"""
+    manage_client.build([], clean_build=clean)
+
+
+@client.command()
+def restore() -> None:
+    """Return to a fresh install of Ithe client"""
     manage_client.restore()
     return None
 
 
 @show.command()
-def version() -> None:
-    """The version of IDOM"""
-    typer.echo(idom.__version__)
+def version(verbose: bool = False) -> None:
+    """Show version information"""
+    if not verbose:
+        console.print(idom.__version__)
+    else:
+        table = Table()
+
+        table.add_column("Package")
+        table.add_column("Version")
+        table.add_column("Language")
+
+        table.add_row("idom", str(idom.__version__), "Python")
+
+        for js_pkg, js_ver in manage_client.dependency_versions().items():
+            table.add_row(js_pkg, js_ver, "Javascript")
+
+        console.print(table)

src/idom/client/manage.py

@@ -4,7 +4,7 @@
 from logging import getLogger
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Iterable, List, Sequence, Set, Union
+from typing import Dict, Iterable, List, Sequence, Set, Union
 
 from idom.config import IDOM_CLIENT_WEB_MODULE_BASE_URL
 
@@ -63,11 +63,16 @@ def web_module_path(package_name: str, must_exist: bool = False) -> Path:
     return path
 
 
+def dependency_versions() -> Dict[str, str]:
+    package_json = _private.build_dir() / "package.json"
+    return json.loads(package_json.read_text())["dependencies"]
+
+
 def restore() -> None:
     _private.restore_build_dir_from_backup()
 
 
-def build(packages_to_install: Sequence[str], clean_build: bool = False) -> None:
+def build(packages_to_install: Sequence[str], clean_build: bool = True) -> None:
     packages_to_install = list(packages_to_install)
 
     with TemporaryDirectory() as tempdir:

src/idom/client/module.py

@@ -38,7 +38,7 @@ def install(
     pkg_names = {_private.get_package_name(pkg) for pkg in packages}
 
     if ignore_installed or pkg_names.difference(manage.web_module_names()):
-        manage.build(packages)
+        manage.build(packages, clean_build=False)
 
     return (
         Module(pkg_names.pop(), fallback=fallback)

tests/test_cli.py

@@ -2,23 +2,36 @@
 
 import idom
 from idom.cli import main
-from idom.client.manage import web_module_exists
+from idom.client.manage import dependency_versions, web_module_exists
 
 
 cli_runner = CliRunner()
 
 
 def test_install():
-    result = cli_runner.invoke(main, ["install", "jquery"])
-    assert result.exit_code == 0
+    assert cli_runner.invoke(main, ["client", "install", "jquery"]).exit_code == 0
     assert web_module_exists("jquery")
 
 
 def test_restore():
-    result = cli_runner.invoke(main, ["restore"])
-    assert result.exit_code == 0
+    assert cli_runner.invoke(main, ["client", "restore"]).exit_code == 0
 
 
 def test_show_version():
-    result = cli_runner.invoke(main, ["show", "version"])
-    assert idom.__version__ in result.stdout
+    terse_result = cli_runner.invoke(main, ["show", "version"])
+    assert idom.__version__ in terse_result.stdout
+
+    verbose_result = cli_runner.invoke(main, ["show", "version", "--verbose"])
+
+    actual_rows = []
+    for line in verbose_result.stdout.split("\n"):
+        maybe_row = list(map(str.strip, filter(None, line.split("│"))))
+        if len(maybe_row) > 1:
+            actual_rows.append(maybe_row)
+
+    expected_rows = [["idom", idom.__version__, "Python"]] + [
+        [js_pkg, js_ver, "Javascript"]
+        for js_pkg, js_ver in dependency_versions().items()
+    ]
+
+    assert actual_rows == expected_rows