CLI command kedro viz build added

README.md

@@ -147,6 +147,12 @@ Options:
   -h, --help          Show this message and exit.
 ```
 
+To create build directory of local Kedro Viz instance with static data from the command line, use the following command from the root folder of your Kedro project:
+
+```bash
+kedro viz build
+```
+
 ### Experiment Tracking usage
 
 To enable [experiment tracking](https://docs.kedro.org/en/stable/experiment_tracking/index.html) in Kedro-Viz, you need to add the Kedro-Viz `SQLiteStore` to your Kedro project.

RELEASE.md

@@ -5,6 +5,12 @@ Please follow the established format:
 - Use present tense (e.g. 'Add new feature')
 - Include the ID number for the related PR (or PRs) in parentheses
 -->
+
+# Release 7.1.0
+
+## Major features and improvements
+- Add build command to the CLI using `kedro viz build` for creating build directory of local Kedro Viz instance with static data. (#1615)
+
 # Release 7.0.0
 
 ## Major features and improvements

package/kedro_viz/api/graphql/router.py

@@ -1,4 +1,5 @@
 """`kedro_viz.api.graphql.router` defines GraphQL routes."""
+# mypy: ignore-errors
 from fastapi import APIRouter
 from strawberry.asgi import GraphQL
 

package/kedro_viz/launchers/cli.py

@@ -1,6 +1,7 @@
 """`kedro_viz.launchers.cli` launches the viz server as a CLI app."""
 
 import multiprocessing
+import shutil
 import traceback
 from pathlib import Path
 from typing import Dict
@@ -24,6 +25,8 @@
 from kedro_viz.server import load_and_populate_data
 
 _VIZ_PROCESSES: Dict[str, int] = {}
+_HTML_DIR = Path(__file__).parent.parent.absolute() / "html"
+_BUILD_PATH = "build"
 
 
 @click.group(name="Kedro-Viz")
@@ -270,3 +273,49 @@ def deploy(region, bucket_name):
         )
     finally:
         viz_deploy_timer.terminate()
+
+
+@viz.command(context_settings={"help_option_names": ["-h", "--help"]})
+def build():
+    """Create build directory of local Kedro Viz instance with static data"""
+
+    if not _HTML_DIR.exists():
+        click.echo(
+            click.style(
+                "ERROR: Directory containing Kedro Viz static files not found.",
+                fg="red",
+            ),
+        )
+        return
+
+    try:
+        # Create the build directory if not present
+        build_path = Path(_BUILD_PATH)
+        build_path.mkdir(parents=True, exist_ok=True)
+
+        # Copy static files from Kedro Viz app to the build directory
+        copy_static_files(build_path)
+
+        click.echo(
+            click.style(
+                f"Kedro-Viz build files have been successfully added to the "
+                f"{build_path} directory.",
+                fg="green",
+            )
+        )
+
+    except Exception as ex:
+        traceback.print_exc()
+        raise KedroCliError(str(ex)) from ex
+
+
+def copy_static_files(build_path: Path):
+    """Copy static files from Kedro-Viz app to the build directory."""
+
+    # Check if the destination directory already exists
+    if build_path.exists():
+        # Remove existing directory
+        shutil.rmtree(build_path)
+
+    # Copy static files directly to the build directory
+    shutil.copytree(_HTML_DIR, build_path)

package/tests/test_launchers/test_cli.py

@@ -1,3 +1,4 @@
+import os
 from unittest.mock import call
 
 import pytest
@@ -21,6 +22,20 @@ def patched_start_browser(mocker):
     mocker.patch("kedro_viz.launchers.cli._start_browser")
 
 
+@pytest.fixture
+def path_operation(tmp_path):
+    build_path = tmp_path / "build"
+    static_files = tmp_path / "static"
+    static_files.mkdir(parents=True, exist_ok=True)
+    (static_files / "file1.txt").touch()
+    (static_files / "file2.txt").touch()
+
+    return {
+        "build_path": build_path,
+        "static_files": static_files,
+    }
+
+
 @pytest.mark.parametrize(
     "command_options,run_server_args",
     [
@@ -234,7 +249,9 @@ def test_viz_command_group(mocker):
             "Usage: Kedro-Viz viz [OPTIONS] COMMAND [ARGS]...\n\n  "
             "Visualise a Kedro pipeline using Kedro viz.\n\n"
             "Options:\n  --help  Show this message and exit.\n\n"
-            "Commands:\n  deploy  Deploy and host Kedro Viz on AWS S3\n  "
+            "Commands:\n  build   Create build directory of local Kedro Viz "
+            "instance with static data\n  "
+            "deploy  Deploy and host Kedro Viz on AWS S3\n  "
             "run     Launch local Kedro Viz instance\x1b[0m"
         ),
     ]
@@ -324,3 +341,51 @@ def test_viz_deploy_invalid_region(mocker):
         )
     ]
     mock_click_echo.assert_has_calls(mock_click_echo_calls)
+
+
+def test_successful_build_with_existing_static_files(mocker, path_operation):
+    env = path_operation
+    mocker.patch("kedro_viz.launchers.cli._HTML_DIR", env["static_files"])
+    mocker.patch("kedro_viz.launchers.cli._BUILD_PATH", env["build_path"])
+
+    runner = CliRunner()
+    result = runner.invoke(cli.build)
+
+    assert result.exit_code == 0
+    assert "successfully added" in result.output
+
+
+def test_build_failure_with_missing_static_files(mocker, tmp_path):
+    mocker.patch("kedro_viz.launchers.cli._HTML_DIR", tmp_path / "non_existing")
+    mocker.patch("kedro_viz.launchers.cli._BUILD_PATH", tmp_path / "build")
+
+    runner = CliRunner()
+    result = runner.invoke(cli.build)
+
+    assert "ERROR" in result.output
+    assert "not found" in result.output
+
+
+def test_copy_static_files_with_existing_build_directory(mocker, path_operation):
+    env = path_operation
+    mocker.patch("kedro_viz.launchers.cli._HTML_DIR", env["static_files"])
+    mocker.patch("kedro_viz.launchers.cli._BUILD_PATH", env["build_path"])
+
+    cli.copy_static_files(env["build_path"])
+
+    assert len(os.listdir(env["build_path"])) == 2
+    assert not os.path.exists(env["build_path"] / "static")
+
+
+def test_build_with_exception(mocker, path_operation):
+    env = path_operation
+    mocker.patch("kedro_viz.launchers.cli._HTML_DIR", env["static_files"])
+    mocker.patch("kedro_viz.launchers.cli._BUILD_PATH", env["build_path"])
+
+    mocker.patch("shutil.copytree", side_effect=Exception("Test exception"))
+
+    runner = CliRunner()
+    result = runner.invoke(cli.build)
+
+    assert result.exit_code != 0
+    assert "Test exception" in result.output