Add addon flags to kedro new

kedro/framework/cli/starters.py

@@ -11,7 +11,6 @@
 import stat
 import sys
 import tempfile
-import warnings
 from collections import OrderedDict
 from itertools import groupby
 from pathlib import Path
@@ -22,7 +21,6 @@
 from attrs import define, field
 
 import kedro
-from kedro import KedroDeprecationWarning
 from kedro import __version__ as version
 from kedro.framework.cli.utils import (
     CONTEXT_SETTINGS,
@@ -38,13 +36,6 @@
 TEMPLATE_PATH = KEDRO_PATH / "templates" / "project"
 _STARTERS_REPO = "git+https://github.com/kedro-org/kedro-starters.git"
 
-_DEPRECATED_STARTERS = [
-    "pandas-iris",
-    "pyspark-iris",
-    "pyspark",
-    "standalone-datacatalog",
-]
-
 
 @define(order=True)
 class KedroStarterSpec:  # noqa: too-few-public-methods
@@ -101,6 +92,23 @@ class KedroStarterSpec:  # noqa: too-few-public-methods
     "An optional directory inside the repository where the starter resides."
 )
 
+# TODO; Insert actual link to the documentation (Visit: kedro.org/{insert-documentation} to find out more about these add-ons.).
+ADDON_ARG_HELP = """
+Select which add-ons you'd like to include. By default, none are included.\n
+
+Add-Ons\n
+1) Linting: Provides a basic linting setup with Black and Ruff\n
+2) Testing: Provides basic testing setup with pytest\n
+3) Custom Logging: Provides more logging options\n
+4) Documentation: Basic documentation setup with Sphinx\n
+5) Data Structure: Provides a directory structure for storing data\n
+
+Example usage:\n
+kedro new --addons=lint,test,log,docs,data (or any subset of these options)\n
+kedro new --addons=all\n
+kedro new --addons=none
+"""
+
 
 # noqa: unused-argument
 def _remove_readonly(func: Callable, path: Path, excinfo: tuple):  # pragma: no cover
@@ -163,14 +171,10 @@ def _starter_spec_to_dict(
     """Convert a dictionary of starters spec to a nicely formatted dictionary"""
     format_dict: dict[str, dict[str, str]] = {}
     for alias, spec in starter_specs.items():
-        if alias in _DEPRECATED_STARTERS:
-            key = alias + " (deprecated)"
-        else:
-            key = alias
-        format_dict[key] = {}  # Each dictionary represent 1 starter
-        format_dict[key]["template_path"] = spec.template_path
+        format_dict[alias] = {}  # Each dictionary represent 1 starter
+        format_dict[alias]["template_path"] = spec.template_path
         if spec.directory:
-            format_dict[key]["directory"] = spec.directory
+            format_dict[alias]["directory"] = spec.directory
     return format_dict
 
 
@@ -191,21 +195,9 @@ def create_cli():  # pragma: no cover
 @click.option("--starter", "-s", "starter_alias", help=STARTER_ARG_HELP)
 @click.option("--checkout", help=CHECKOUT_ARG_HELP)
 @click.option("--directory", help=DIRECTORY_ARG_HELP)
-def new(config_path, starter_alias, checkout, directory, **kwargs):
+@click.option("--addons", "-a", "selected_addons", help=ADDON_ARG_HELP)
+def new(config_path, starter_alias, selected_addons, checkout, directory, **kwargs):
     """Create a new kedro project."""
-
-    if starter_alias in _DEPRECATED_STARTERS:
-        warnings.warn(
-            f"The starter '{starter_alias}' has been deprecated and will be archived from Kedro 0.19.0.",
-            KedroDeprecationWarning,
-        )
-    click.secho(
-        "From Kedro 0.19.0, the command `kedro new` will come with the option of interactively selecting add-ons "
-        "for your project such as linting, testing, custom logging, and more. The selected add-ons will add the "
-        "basic setup for the utilities selected to your projects.",
-        fg="green",
-    )
-
     if checkout and not starter_alias:
         raise KedroCliError("Cannot use the --checkout flag without a --starter value.")
 
@@ -237,6 +229,11 @@ def new(config_path, starter_alias, checkout, directory, **kwargs):
     tmpdir = tempfile.mkdtemp()
     cookiecutter_dir = _get_cookiecutter_dir(template_path, checkout, directory, tmpdir)
     prompts_required = _get_prompts_required(cookiecutter_dir)
+
+    # Remove the prompt asking for add-ons if the user already passed them through CLI.
+    if selected_addons is not None:
+        del prompts_required["add_ons"]
+
     # We only need to make cookiecutter_context if interactive prompts are needed.
     if not config_path:
         cookiecutter_context = _make_cookiecutter_context_for_prompts(cookiecutter_dir)
@@ -262,6 +259,8 @@ def new(config_path, starter_alias, checkout, directory, **kwargs):
     else:
         config = _fetch_config_from_user_prompts(prompts_required, cookiecutter_context)
 
+    config = _get_addons_from_cli_input(selected_addons, config)
+
     cookiecutter_args = _make_cookiecutter_args(config, checkout, directory)
     _create_project(template_path, cookiecutter_args)
 
@@ -288,9 +287,6 @@ def list_starters():
     sorted_starters_dict = dict(
         sorted(sorted_starters_dict.items(), key=lambda x: x == "kedro")
     )
-    warnings.warn(
-        f"The starters {_DEPRECATED_STARTERS} are deprecated and will be archived in Kedro 0.19.0."
-    )
 
     for origin, starters_spec in sorted_starters_dict.items():
         click.secho(f"\nStarters from {origin}\n", fg="yellow")
@@ -299,6 +295,34 @@ def list_starters():
         )
 
 
+def _get_addons_from_cli_input(
+    selected_addons: str, config: dict[str, str]
+) -> dict[str, str]:
+    """Inserts add-on selection from the CLI input in the project
+    configuration, if it exists. Replaces add-on strings with the
+    corresponding prompt number.
+
+    Args:
+        selected_addons: a string containing the value for the --addons flag,
+            or None in case the flag wasn't used.
+
+    Returns:
+        Configuration for starting a new project, with the selected add-ons
+        from the `--addons` flag.
+    """
+    string_to_number = {"lint": "1", "test": "2", "log": "3", "docs": "4", "data": "5"}
+
+    if selected_addons is not None:
+        addons = selected_addons.split(",")
+        for i in range(len(addons)):
+            addon = addons[i]
+            if addon in string_to_number:
+                addons[i] = string_to_number[addon]
+        config["add_ons"] = ",".join(addons)
+
+    return config
+
+
 def _fetch_config_from_file(config_path: str) -> dict[str, str]:
     """Obtains configuration for a new kedro project non-interactively from a file.
 

tests/framework/cli/test_starters.py

@@ -56,6 +56,24 @@ def _make_cli_prompt_input(
     return "\n".join([add_ons, project_name, repo_name, python_package])
 
 
+def _make_cli_prompt_input_without_addons(
+    project_name="", repo_name="", python_package=""
+):
+    return "\n".join([project_name, repo_name, python_package])
+
+
+def _convert_addon_names_to_numbers(selected_addons: str):
+    string_to_number = {"lint": "1", "test": "2", "log": "3", "docs": "4", "data": "5"}
+
+    addons = selected_addons.split(",")
+    for i in range(len(addons)):
+        addon = addons[i]
+        if addon in string_to_number:
+            addons[i] = string_to_number[addon]
+
+    return ",".join(addons)
+
+
 def _get_expected_files(add_ons: str):
     add_ons_template_files = {
         "1": 0,
@@ -933,3 +951,40 @@ def test_invalid_add_ons(self, fake_kedro_cli):
             "Please select valid options for add-ons using comma-separated values, ranges, or 'all/none'.\n"
             in result.output
         )
+
+
+@pytest.mark.usefixtures("chdir_to_tmp")
+class TestAddOnsFromCLI:
+    @pytest.mark.parametrize(
+        "add_ons",
+        [
+            "lint",
+            "test",
+            "log",
+            "docs",
+            "data",
+            "none",
+            "test,log,docs",
+            "test,data,lint",
+            "log,docs,data,test,lint",
+            "all",
+        ],
+    )
+    def test_valid_add_ons(self, fake_kedro_cli, add_ons):
+        result = CliRunner().invoke(
+            fake_kedro_cli,
+            ["new", "--addons", add_ons],
+            input=_make_cli_prompt_input_without_addons(),
+        )
+        add_ons = _convert_addon_names_to_numbers(selected_addons=add_ons)
+        _assert_template_ok(result, add_ons=add_ons)
+        _assert_requirements_ok(result, add_ons=add_ons)
+
+    def test_invalid_add_ons(self, fake_kedro_cli):
+        result = CliRunner().invoke(
+            fake_kedro_cli,
+            ["new", "--addons", "bad_input"],
+            input=_make_cli_prompt_input_without_addons(),
+        )
+
+        assert result.exit_code != 0

tests/tools/test_cli.py

@@ -101,6 +101,8 @@ def test_get_cli_structure_depth(self, mocker, fake_metadata):
                 "-v",
                 "--config",
                 "-c",
+                "--addons",
+                "-a",
                 "--starter",
                 "-s",
                 "--checkout",