cognite-toolkit 0.5.97__py3-none-any.whl → 0.7.34__py3-none-any.whl

cognite_toolkit/_cdf_tk/apps/_dump_app.py

@@ -6,58 +6,52 @@ from cognite.client.data_classes import WorkflowVersionId
 from cognite.client.data_classes.data_modeling import DataModelId, ViewId
 from rich import print
 
-from cognite_toolkit._cdf_tk.commands import DumpDataCommand, DumpResourceCommand
-from cognite_toolkit._cdf_tk.commands.dump_data import (
-    AssetFinder,
-    EventFinder,
-    FileMetadataFinder,
-    TimeSeriesFinder,
-)
+from cognite_toolkit._cdf_tk.client.data_classes.search_config import ViewId as SearchConfigViewId
+from cognite_toolkit._cdf_tk.commands import DumpResourceCommand
 from cognite_toolkit._cdf_tk.commands.dump_resource import (
     AgentFinder,
     DataModelFinder,
+    DataSetFinder,
     ExtractionPipelineFinder,
+    FunctionFinder,
     GroupFinder,
     LocationFilterFinder,
     NodeFinder,
+    SearchConfigFinder,
+    SpaceFinder,
+    StreamlitFinder,
     TransformationFinder,
     WorkflowFinder,
 )
 from cognite_toolkit._cdf_tk.exceptions import ToolkitRequiredValueError
 from cognite_toolkit._cdf_tk.feature_flags import Flags
 from cognite_toolkit._cdf_tk.utils.auth import EnvironmentVariables
-from cognite_toolkit._cdf_tk.utils.interactive_select import (
-    AssetInteractiveSelect,
-    EventInteractiveSelect,
-    FileMetadataInteractiveSelect,
-    TimeSeriesInteractiveSelect,
-)
 
 
 class DumpApp(typer.Typer):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
         self.callback(invoke_without_command=True)(self.dump_main)
-        if Flags.DUMP_DATA.is_enabled():
-            self.add_typer(DumpDataApp(*args, **kwargs), name="data")
-            self.add_typer(DumpConfigApp(*args, **kwargs), name="config")
-        else:
-            self.command("datamodel")(DumpConfigApp.dump_datamodel_cmd)
+        self.command("datamodel")(DumpConfigApp.dump_datamodel_cmd)
 
-            self.command("asset")(DumpDataApp.dump_asset_cmd)
-            self.command("timeseries")(DumpDataApp.dump_timeseries_cmd)
+        self.command("asset")(DumpDataApp.dump_asset_cmd)
+        self.command("timeseries")(DumpDataApp.dump_timeseries_cmd)
 
-            self.command("workflow")(DumpConfigApp.dump_workflow)
-            self.command("transformation")(DumpConfigApp.dump_transformation)
-            self.command("group")(DumpConfigApp.dump_group)
-            self.command("node")(DumpConfigApp.dump_node)
+        self.command("workflow")(DumpConfigApp.dump_workflow)
+        self.command("transformation")(DumpConfigApp.dump_transformation)
+        self.command("group")(DumpConfigApp.dump_group)
+        self.command("node")(DumpConfigApp.dump_node)
+        self.command("spaces")(DumpConfigApp.dump_spaces)
 
-            if Flags.DUMP_EXTENDED.is_enabled():
-                self.command("location-filter")(DumpConfigApp.dump_location_filters)
-                self.command("extraction-pipeline")(DumpConfigApp.dump_extraction_pipeline)
+        self.command("location-filter")(DumpConfigApp.dump_location_filters)
+        self.command("extraction-pipeline")(DumpConfigApp.dump_extraction_pipeline)
+        self.command("functions")(DumpConfigApp.dump_functions)
+        self.command("datasets")(DumpConfigApp.dump_datasets)
+        self.command("streamlit")(DumpConfigApp.dump_streamlit)
 
-            if Flags.AGENTS.is_enabled() and Flags.DUMP_EXTENDED.is_enabled():
-                self.command("agents")(DumpConfigApp.dump_agents)
+        self.command("agents")(DumpConfigApp.dump_agents)
+
+        self.command("search-config")(DumpConfigApp.dump_search_config)
 
     @staticmethod
     def dump_main(ctx: typer.Context) -> None:
@@ -77,11 +71,14 @@ class DumpConfigApp(typer.Typer):
         self.command("transformation")(self.dump_transformation)
         self.command("group")(self.dump_group)
         self.command("node")(self.dump_node)
-        if Flags.DUMP_EXTENDED.is_enabled():
-            self.command("location-filters")(self.dump_location_filters)
-            self.command("extraction-pipeline")(self.dump_extraction_pipeline)
-        if Flags.DUMP_EXTENDED.is_enabled() and Flags.AGENTS.is_enabled():
-            self.command("agents")(self.dump_agents)
+        self.command("spaces")(self.dump_spaces)
+        self.command("location-filters")(self.dump_location_filters)
+        self.command("extraction-pipeline")(self.dump_extraction_pipeline)
+        self.command("datasets")(DumpConfigApp.dump_datasets)
+        self.command("functions")(self.dump_functions)
+        self.command("streamlit")(DumpConfigApp.dump_streamlit)
+        self.command("agents")(self.dump_agents)
+        self.command("search-config")(self.dump_search_config)
 
     @staticmethod
     def dump_config_main(ctx: typer.Context) -> None:
@@ -265,10 +262,10 @@ class DumpConfigApp(typer.Typer):
     def dump_group(
         ctx: typer.Context,
         group_name: Annotated[
-            str | None,
+            list[str] | None,
             typer.Argument(
-                help="Group name to dump. Format: name. Example: 'my_group'. "
-                "If nothing is provided, an interactive prompt will be shown to select the group.",
+                help="Group name(s) to dump. Format: name. Example: 'my_group'. "
+                "If nothing is provided, an interactive prompt will be shown to select the group(s).",
             ),
         ] = None,
         output_dir: Annotated[
@@ -303,7 +300,7 @@ class DumpConfigApp(typer.Typer):
         cmd = DumpResourceCommand()
         cmd.run(
             lambda: cmd.dump_to_yamls(
-                GroupFinder(client, group_name),
+                GroupFinder(client, tuple(group_name) if group_name else None),
                 output_dir=output_dir,
                 clean=clean,
                 verbose=verbose,
@@ -514,6 +511,253 @@ class DumpConfigApp(typer.Typer):
             )
         )
 
+    @staticmethod
+    def dump_datasets(
+        ctx: typer.Context,
+        external_id: Annotated[
+            list[str] | None,
+            typer.Argument(
+                help="The external ID(s) of the datasets you want to dump. "
+                "If nothing is provided, an interactive prompt will be shown to select the datasets.",
+            ),
+        ] = None,
+        output_dir: Annotated[
+            Path,
+            typer.Option(
+                "--output-dir",
+                "-o",
+                help="Where to dump the dataset files.",
+                allow_dash=True,
+            ),
+        ] = Path("tmp"),
+        clean: Annotated[
+            bool,
+            typer.Option(
+                "--clean",
+                "-c",
+                help="Delete the output directory before dumping the datasets.",
+            ),
+        ] = False,
+        verbose: Annotated[
+            bool,
+            typer.Option(
+                "--verbose",
+                "-v",
+                help="Turn on to get more verbose output when running the command",
+            ),
+        ] = False,
+    ) -> None:
+        """This command will dump the selected datasets as yaml to the folder specified, defaults to /tmp."""
+        client = EnvironmentVariables.create_from_environment().get_client()
+        cmd = DumpResourceCommand()
+        cmd.run(
+            lambda: cmd.dump_to_yamls(
+                DataSetFinder(client, tuple(external_id) if external_id else None),
+                output_dir=output_dir,
+                clean=clean,
+                verbose=verbose,
+            )
+        )
+
+    @staticmethod
+    def dump_functions(
+        ctx: typer.Context,
+        external_id: Annotated[
+            list[str] | None,
+            typer.Argument(
+                help="The external ID(s) of the functions you want to dump. "
+                "If nothing is provided, an interactive prompt will be shown to select the functions.",
+            ),
+        ] = None,
+        output_dir: Annotated[
+            Path,
+            typer.Option(
+                "--output-dir",
+                "-o",
+                help="Where to dump the function files.",
+                allow_dash=True,
+            ),
+        ] = Path("tmp"),
+        clean: Annotated[
+            bool,
+            typer.Option(
+                "--clean",
+                "-c",
+                help="Delete the output directory before dumping the functions.",
+            ),
+        ] = False,
+        verbose: Annotated[
+            bool,
+            typer.Option(
+                "--verbose",
+                "-v",
+                help="Turn on to get more verbose output when running the command",
+            ),
+        ] = False,
+    ) -> None:
+        """This command will dump the selected functions as yaml to the folder specified, defaults to /tmp."""
+        client = EnvironmentVariables.create_from_environment().get_client()
+        cmd = DumpResourceCommand()
+        cmd.run(
+            lambda: cmd.dump_to_yamls(
+                FunctionFinder(client, tuple(external_id) if external_id else None),
+                output_dir=output_dir,
+                clean=clean,
+                verbose=verbose,
+            )
+        )
+
+    @staticmethod
+    def dump_streamlit(
+        ctx: typer.Context,
+        external_id: Annotated[
+            list[str] | None,
+            typer.Argument(
+                help="The external ID(s) of the Streamlit apps you want to dump. "
+                "If nothing is provided, an interactive prompt will be shown to select the Streamlit apps.",
+            ),
+        ] = None,
+        output_dir: Annotated[
+            Path,
+            typer.Option(
+                "--output-dir",
+                "-o",
+                help="Where to dump the Streamlit app files.",
+                allow_dash=True,
+            ),
+        ] = Path("tmp"),
+        clean: Annotated[
+            bool,
+            typer.Option(
+                "--clean",
+                "-c",
+                help="Delete the output directory before dumping the Streamlit apps.",
+            ),
+        ] = False,
+        verbose: Annotated[
+            bool,
+            typer.Option(
+                "--verbose",
+                "-v",
+                help="Turn on to get more verbose output when running the command",
+            ),
+        ] = False,
+    ) -> None:
+        """This command will dump the selected Streamlit apps as yaml to the folder specified, defaults to /tmp."""
+        client = EnvironmentVariables.create_from_environment().get_client()
+        cmd = DumpResourceCommand()
+        cmd.run(
+            lambda: cmd.dump_to_yamls(
+                StreamlitFinder(client, tuple(external_id) if external_id else None),
+                output_dir=output_dir,
+                clean=clean,
+                verbose=verbose,
+            )
+        )
+
+    @staticmethod
+    def dump_spaces(
+        ctx: typer.Context,
+        spaces: Annotated[
+            list[str] | None,
+            typer.Argument(
+                help="The name of the instance space(s) you want to dump. "
+                "If nothing is provided, an interactive prompt will be shown to select the instance spaces.",
+            ),
+        ] = None,
+        output_dir: Annotated[
+            Path,
+            typer.Option(
+                "--output-dir",
+                "-o",
+                help="Where to dump the instance space files.",
+                allow_dash=True,
+            ),
+        ] = Path("tmp"),
+        clean: Annotated[
+            bool,
+            typer.Option(
+                "--clean",
+                "-c",
+                help="Delete the output directory before dumping the instance spaces.",
+            ),
+        ] = False,
+        verbose: Annotated[
+            bool,
+            typer.Option(
+                "--verbose",
+                "-v",
+                help="Turn on to get more verbose output when running the command",
+            ),
+        ] = False,
+    ) -> None:
+        """This command will dump the selected instance spaces as yaml to the folder specified, defaults to /tmp."""
+        client = EnvironmentVariables.create_from_environment().get_client()
+        cmd = DumpResourceCommand()
+        cmd.run(
+            lambda: cmd.dump_to_yamls(
+                SpaceFinder(client, tuple(spaces) if spaces else None),
+                output_dir=output_dir,
+                clean=clean,
+                verbose=verbose,
+            )
+        )
+
+    @staticmethod
+    def dump_search_config(
+        ctx: typer.Context,
+        view_id: Annotated[
+            list[str] | None,
+            typer.Argument(
+                help="The view for which you want to dump the search configuration. Format: externalId space. Example: 'my_external_id my_space'."
+                "If nothing is provided, an interactive prompt will be shown to select the view for which search configurations are available.",
+            ),
+        ] = None,
+        output_dir: Annotated[
+            Path,
+            typer.Option(
+                "--output-dir",
+                "-o",
+                help="Where to dump the search configuration files for the selected view.",
+                allow_dash=True,
+            ),
+        ] = Path("tmp"),
+        clean: Annotated[
+            bool,
+            typer.Option(
+                "--clean",
+                "-c",
+                help="Delete the output directory before dumping the search configuration for the selected view.",
+            ),
+        ] = False,
+        verbose: Annotated[
+            bool,
+            typer.Option(
+                "--verbose",
+                "-v",
+                help="Turn on to get more verbose output when running the command",
+            ),
+        ] = False,
+    ) -> None:
+        """This command will dump the selected view's search configuration as yaml to the folder specified, defaults to /tmp."""
+        client = EnvironmentVariables.create_from_environment().get_client()
+        selected_view_id: Union[None, SearchConfigViewId] = None
+        if view_id is not None:
+            if len(view_id) != 2:
+                raise ToolkitRequiredValueError(
+                    "View ID must be provided as exactly two arguments: externalId and space."
+                )
+            selected_view_id = SearchConfigViewId(*view_id)
+        cmd = DumpResourceCommand()
+        cmd.run(
+            lambda: cmd.dump_to_yamls(
+                SearchConfigFinder(client, tuple([selected_view_id]) if selected_view_id else None),
+                output_dir=output_dir,
+                clean=clean,
+                verbose=verbose,
+            )
+        )
+
 
 class DumpDataApp(typer.Typer):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
@@ -594,21 +838,11 @@ class DumpDataApp(typer.Typer):
         ] = False,
     ) -> None:
         """This command will dump the selected assets in the selected format to the folder specified, defaults to /tmp."""
-        cmd = DumpDataCommand()
-        client = EnvironmentVariables.create_from_environment().get_client()
-        if hierarchy is None and data_set is None:
-            hierarchy, data_set = AssetInteractiveSelect(client, "dump").select_hierarchies_and_data_sets()
-
-        cmd.run(
-            lambda: cmd.dump_table(
-                AssetFinder(client, hierarchy or [], data_set or []),
-                output_dir,
-                clean,
-                limit,
-                format_,  # type: ignore [arg-type]
-                verbose,
+        if Flags.v08:
+            raise ValueError(
+                "The `cdf dump data asset` command has been removed. Please use `cdf data download assets` instead."
             )
-        )
+        print("[bold yellow]Warning:[/] This command has been removed. Please use `cdf data download assets` instead.")
 
     @staticmethod
     def dump_files_cmd(
@@ -672,21 +906,12 @@ class DumpDataApp(typer.Typer):
         ] = False,
     ) -> None:
         """This command will dump the selected events to the selected format in the folder specified, defaults to /tmp."""
-        cmd = DumpDataCommand()
-        cmd.validate_directory(output_dir, clean)
-        client = EnvironmentVariables.create_from_environment().get_client()
-        if hierarchy is None and data_set is None:
-            hierarchy, data_set = FileMetadataInteractiveSelect(client, "dump").select_hierarchies_and_data_sets()
-        cmd.run(
-            lambda: cmd.dump_table(
-                FileMetadataFinder(client, hierarchy or [], data_set or []),
-                output_dir,
-                clean,
-                limit,
-                format_,  # type: ignore [arg-type]
-                verbose,
+        if Flags.v08:
+            raise ValueError(
+                "The `cdf dump data files-metadata` command has been removed. Please use `cdf data download files` instead."
             )
-        )
+        print("[bold yellow]Warning:[/] This command has been removed. Please use `cdf data download files` instead.")
+        return None
 
     @staticmethod
     def dump_timeseries_cmd(
@@ -750,20 +975,14 @@ class DumpDataApp(typer.Typer):
         ] = False,
     ) -> None:
         """This command will dump the selected timeseries to the selected format in the folder specified, defaults to /tmp."""
-        cmd = DumpDataCommand()
-        client = EnvironmentVariables.create_from_environment().get_client()
-        if hierarchy is None and data_set is None:
-            hierarchy, data_set = TimeSeriesInteractiveSelect(client, "dump").select_hierarchies_and_data_sets()
-        cmd.run(
-            lambda: cmd.dump_table(
-                TimeSeriesFinder(client, hierarchy or [], data_set or []),
-                output_dir,
-                clean,
-                limit,
-                format_,  # type: ignore [arg-type]
-                verbose,
+        if Flags.v08:
+            raise ValueError(
+                "The `cdf dump data timeseries` command has been removed. Please use `cdf data download timeseries` instead."
             )
+        print(
+            "[bold yellow]Warning:[/] This command has been removed. Please use `cdf data download timeseries` instead."
         )
+        return None
 
     @staticmethod
     def dump_event_cmd(
@@ -827,18 +1046,9 @@ class DumpDataApp(typer.Typer):
         ] = False,
     ) -> None:
         """This command will dump the selected events to the selected format in the folder specified, defaults to /tmp."""
-        cmd = DumpDataCommand()
-        cmd.validate_directory(output_dir, clean)
-        client = EnvironmentVariables.create_from_environment().get_client()
-        if hierarchy is None and data_set is None:
-            hierarchy, data_set = EventInteractiveSelect(client, "dump").select_hierarchies_and_data_sets()
-        cmd.run(
-            lambda: cmd.dump_table(
-                EventFinder(client, hierarchy or [], data_set or []),
-                output_dir,
-                clean,
-                limit,
-                format_,
-                verbose,
+        if Flags.v08:
+            raise ValueError(
+                "The `cdf dump data event` command has been removed. Please use `cdf data download events` instead."
             )
-        )
+        print("[bold yellow]Warning:[/] This command has been removed. Please use `cdf data download events` instead.")
+        return None

cognite_toolkit/_cdf_tk/apps/_import_app.py

@@ -0,0 +1,41 @@
+from pathlib import Path
+from typing import Any
+
+import typer
+
+from cognite_toolkit._cdf_tk.client import ToolkitClient
+from cognite_toolkit._cdf_tk.commands._import_cmd import ImportTransformationCLI
+from cognite_toolkit._cdf_tk.utils.auth import EnvironmentVariables
+
+
+class ImportApp(typer.Typer):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.callback(invoke_without_command=True)(self.main)
+        self.command("transformation-cli")(self.transformation_cli)
+
+    def main(self, ctx: typer.Context) -> None:
+        """PREVIEW FEATURE Import resources into Cognite-Toolkit."""
+        if ctx.invoked_subcommand is None:
+            print("Use [bold yellow]cdf-tk import --help[/] for more information.")
+        return None
+
+    @staticmethod
+    def transformation_cli(
+        source: Path = typer.Argument(..., help="Path to the transformation CLI manifest directory or files."),
+        destination: Path = typer.Argument(..., help="Path to the destination directory."),
+        overwrite: bool = typer.Option(False, help="Overwrite destination if it already exists."),
+        flatten: bool = typer.Option(False, help="Flatten the directory structure."),
+        clean: bool = typer.Option(False, help="Remove the source directory after import."),
+        verbose: bool = typer.Option(False, help="Turn on to get more verbose output when running the command"),
+    ) -> None:
+        """Import transformation CLI manifests into Cognite-Toolkit modules."""
+
+        # We are lazy loading the client as we only need it if we need to look up dataset ids.
+        # This is to ensure the command can be executed without a client if the user does not need to look up dataset ids.
+        # (which is likely 99% of the time)
+        def get_client() -> ToolkitClient:
+            return EnvironmentVariables.create_from_environment().get_client()
+
+        cmd = ImportTransformationCLI(print_warning=True, get_client=get_client)
+        cmd.execute(source, destination, overwrite, flatten, clean, verbose=verbose)

cognite_toolkit/_cdf_tk/apps/_landing_app.py

@@ -1,3 +1,5 @@
+from typing import Annotated
+
 import typer
 
 from cognite_toolkit._cdf_tk.commands import InitCommand
@@ -6,9 +8,21 @@ from cognite_toolkit._cdf_tk.commands import InitCommand
 class LandingApp(typer.Typer):
     def __init__(self, *args, **kwargs) -> None:  # type: ignore
         super().__init__(*args, **kwargs)
-        self.command()(self.main_init)
 
-    def main_init(self) -> None:
-        """Guidance on how to get started"""
+    def main_init(
+        self,
+        dry_run: Annotated[
+            bool,
+            typer.Option(
+                "--dry-run",
+                "-r",
+                help="Whether to do a dry-run, do dry-run if present.",
+            ),
+        ] = False,
+    ) -> None:
+        """Getting started checklist"""
         cmd = InitCommand()
-        cmd.run(cmd.execute)
+        # Tracking  command with the usual lambda run construct
+        # is intentionally left out because we don't want to expose the user to the warning
+        # before they've had the chance to opt in (which is something they'll do later using this command).
+        cmd.execute(dry_run=dry_run)