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

cognite_toolkit/_cdf.py

@@ -24,25 +24,26 @@ from rich import print
 from cognite_toolkit._cdf_tk.apps import (
     AuthApp,
     CoreApp,
+    DataApp,
+    DevApp,
     DumpApp,
+    ImportApp,
     LandingApp,
     MigrateApp,
     ModulesApp,
-    PopulateApp,
     ProfileApp,
-    PurgeApp,
     RepoApp,
     RunApp,
 )
 from cognite_toolkit._cdf_tk.cdf_toml import CDFToml
 from cognite_toolkit._cdf_tk.commands import (
-    CollectCommand,
+    AboutCommand,
 )
 from cognite_toolkit._cdf_tk.constants import HINT_LEAD_TEXT, URL, USE_SENTRY
 from cognite_toolkit._cdf_tk.exceptions import (
     ToolkitError,
 )
-from cognite_toolkit._cdf_tk.feature_flags import FeatureFlag, Flags
+from cognite_toolkit._cdf_tk.feature_flags import Flags
 from cognite_toolkit._cdf_tk.plugins import Plugins
 from cognite_toolkit._cdf_tk.tracker import Tracker
 from cognite_toolkit._cdf_tk.utils import (
@@ -86,21 +87,21 @@ except AttributeError as e:
 _app = CoreApp(**default_typer_kws)
 
 user_app = typer.Typer(**default_typer_kws, hidden=True)  # type: ignore [arg-type]
-landing_app = LandingApp(**default_typer_kws)  # type: ignore [arg-type]
+landing_app = LandingApp(**default_typer_kws)
 
 _app.add_typer(AuthApp(**default_typer_kws), name="auth")
+_app.add_typer(RepoApp(**default_typer_kws), name="repo")
+
+
 if Plugins.run.value.is_enabled():
     _app.add_typer(RunApp(**default_typer_kws), name="run")
-_app.add_typer(RepoApp(**default_typer_kws), name="repo")
 
 if Plugins.dump.value.is_enabled():
     _app.add_typer(DumpApp(**default_typer_kws), name="dump")
 
-if Plugins.purge.value.is_enabled():
-    _app.add_typer(PurgeApp(**default_typer_kws), name="purge")
 
-if Flags.POPULATE.is_enabled():
-    _app.add_typer(PopulateApp(**default_typer_kws), name="populate")
+if Plugins.dev.value.is_enabled():
+    _app.add_typer(DevApp(**default_typer_kws), name="dev")
 
 if Flags.PROFILE.is_enabled():
     _app.add_typer(ProfileApp(**default_typer_kws), name="profile")
@@ -108,19 +109,27 @@ if Flags.PROFILE.is_enabled():
 if Flags.MIGRATE.is_enabled():
     _app.add_typer(MigrateApp(**default_typer_kws), name="migrate")
 
+if Flags.IMPORT_CMD.is_enabled():
+    _app.add_typer(ImportApp(**default_typer_kws), name="import")
+
+if Plugins.data.value.is_enabled():
+    _app.add_typer(DataApp(**default_typer_kws), name="data")
+
 _app.add_typer(ModulesApp(**default_typer_kws), name="modules")
 _app.command("init")(landing_app.main_init)
 
 
+@_app.command("about")
+def about() -> None:
+    """Display information about the Toolkit installation and configuration."""
+    cmd = AboutCommand()
+    cmd.run(lambda: cmd.execute(Path.cwd()))
+
+
 def app() -> NoReturn:
     # --- Main entry point ---
     # Users run 'app()' directly, but that doesn't allow us to control excepton handling:
     try:
-        if FeatureFlag.is_enabled(Flags.IMPORT_CMD):
-            from cognite_toolkit._cdf_tk.prototypes.import_app import import_app
-
-            _app.add_typer(import_app, name="import")
-
         _app()
     except ToolkitError as err:
         if "--verbose" in sys.argv:
@@ -144,17 +153,6 @@ def app() -> NoReturn:
     raise SystemExit(0)
 
 
-@_app.command("collect", hidden=True)
-def collect(
-    action: str = typer.Argument(
-        help="Whether to explicitly opt-in or opt-out of usage data collection. [opt-in, opt-out]"
-    ),
-) -> None:
-    """Collect usage information for the toolkit."""
-    cmd = CollectCommand()
-    cmd.run(lambda: cmd.execute(action))  # type: ignore [arg-type]
-
-
 @user_app.callback(invoke_without_command=True)
 def user_main(ctx: typer.Context) -> None:
     """Commands to give information about the toolkit."""

cognite_toolkit/_cdf_tk/apps/__init__.py

@@ -1,25 +1,33 @@
 from ._auth_app import AuthApp
 from ._core_app import CoreApp
+from ._data_app import DataApp
+from ._dev_app import DevApp
+from ._download_app import DownloadApp
 from ._dump_app import DumpApp
+from ._import_app import ImportApp
 from ._landing_app import LandingApp
 from ._migrate_app import MigrateApp
 from ._modules_app import ModulesApp
-from ._populate_app import PopulateApp
 from ._profile_app import ProfileApp
 from ._purge import PurgeApp
 from ._repo_app import RepoApp
 from ._run import RunApp
+from ._upload_app import UploadApp
 
 __all__ = [
     "AuthApp",
     "CoreApp",
+    "DataApp",
+    "DevApp",
+    "DownloadApp",
     "DumpApp",
+    "ImportApp",
     "LandingApp",
     "MigrateApp",
     "ModulesApp",
-    "PopulateApp",
     "ProfileApp",
     "PurgeApp",
     "RepoApp",
     "RunApp",
+    "UploadApp",
 ]

cognite_toolkit/_cdf_tk/apps/_core_app.py

@@ -3,7 +3,7 @@
 import contextlib
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Annotated, Optional, Union
+from typing import Annotated, Union
 
 import typer
 from dotenv import load_dotenv
@@ -13,6 +13,7 @@ from rich.panel import Panel
 from cognite_toolkit._cdf_tk.cdf_toml import CDFToml
 from cognite_toolkit._cdf_tk.client import ToolkitClient
 from cognite_toolkit._cdf_tk.commands import BuildCommand, CleanCommand, DeployCommand
+from cognite_toolkit._cdf_tk.commands.build_v2.build_cmd import BuildCommand as BuildCommandV2
 from cognite_toolkit._cdf_tk.commands.clean import AVAILABLE_DATA_TYPES
 from cognite_toolkit._cdf_tk.exceptions import ToolkitFileNotFoundError
 from cognite_toolkit._cdf_tk.feature_flags import Flags
@@ -54,7 +55,7 @@ class CoreApp(typer.Typer):
             ),
         ] = True,
         env_path: Annotated[
-            Optional[str],
+            str | None,
             typer.Option(
                 help="Path to .env file to load. Defaults to .env in current or parent directory.",
             ),
@@ -77,7 +78,7 @@ class CoreApp(typer.Typer):
                 Panel(
                     "\n".join(
                         [
-                            "The Cognite Data Fusion Toolkit supports configuration of CDF projects from the command line or in CI/CD pipelines.",
+                            "The Cognite Toolkit supports configuration of CDF projects from the command line or in CI/CD pipelines.",
                             "",
                             "[bold]Setup:[/]",
                             "1. Run [underline]cdf repo init[/] [italic]<directory name>[/] to set up a work directory.",
@@ -89,7 +90,7 @@ class CoreApp(typer.Typer):
                             "",
                             "[bold]Deployment steps:[/]",
                             "4. Commit the [italic]<directory name>[/] to version control",
-                            "5. Run [underline]cdf auth verify --interactive[/] to check that you have access to the relevant CDF project. ",
+                            "5. Run [underline]cdf auth verify[/] to check that you have access to the relevant CDF project. ",
                             "    or [underline]cdf auth verify[/] if you have a .env file",
                             "6. Run [underline]cdf deploy --dry-run[/] to simulate the deployment of the configuration to the CDF project. Review the report provided.",
                             "7. Run [underline]cdf deploy[/] to deploy the configuration to the CDF project.",
@@ -149,7 +150,7 @@ class CoreApp(typer.Typer):
             ),
         ] = Path("./build"),
         selected: Annotated[
-            Optional[list[str]],
+            list[str] | None,
             typer.Option(
                 "--modules",
                 "-m",
@@ -157,7 +158,7 @@ class CoreApp(typer.Typer):
             ),
         ] = None,
         build_env_name: Annotated[
-            Optional[str],
+            str | None,
             typer.Option(
                 "--env",
                 "-e",
@@ -193,7 +194,6 @@ class CoreApp(typer.Typer):
                 "--exit-non-zero-on-warning",
                 "-w",
                 help="Exit with non-zero code on warning.",
-                hidden=not Flags.EXIT_ON_WARNING.is_enabled(),
             ),
         ] = False,
     ) -> None:
@@ -206,10 +206,14 @@ class CoreApp(typer.Typer):
                 client = EnvironmentVariables.create_from_environment().get_client()
 
         print_warning = True
-        if Flags.EXIT_ON_WARNING.is_enabled() and exit_on_warning:
+        if exit_on_warning:
             print_warning = False
 
-        cmd = BuildCommand(print_warning=print_warning)
+        cmd = (
+            BuildCommandV2(print_warning=print_warning)
+            if Flags.v08.is_enabled()
+            else BuildCommand(print_warning=print_warning)
+        )
         cmd.run(
             lambda: cmd.execute(
                 verbose,
@@ -223,7 +227,7 @@ class CoreApp(typer.Typer):
             )
         )
 
-        if Flags.EXIT_ON_WARNING.is_enabled() and exit_on_warning and cmd.warning_list:
+        if exit_on_warning and cmd.warning_list:
             print("\n[bold red]Warnings raised during the build process:[/]\n")
 
             for warning in cmd.warning_list:
@@ -243,7 +247,7 @@ class CoreApp(typer.Typer):
             ),
         ] = Path("./build"),
         build_env_name: Annotated[
-            Optional[str],
+            str | None,
             typer.Option(
                 "--env",
                 "-e",
@@ -275,7 +279,7 @@ class CoreApp(typer.Typer):
             ),
         ] = False,
         include: Annotated[
-            Optional[list[str]],
+            list[str] | None,
             typer.Option(
                 "--include",
                 help=f"Specify which resources to deploy, available options: {AVAILABLE_DATA_TYPES}.",
@@ -301,7 +305,7 @@ class CoreApp(typer.Typer):
         cmd = DeployCommand(print_warning=True)
         env_vars = EnvironmentVariables.create_from_environment()
         cmd.run(
-            lambda: cmd.execute(
+            lambda: cmd.deploy_build_directory(
                 env_vars=env_vars,
                 build_dir=build_dir,
                 build_env_name=build_env_name,
@@ -325,7 +329,7 @@ class CoreApp(typer.Typer):
             ),
         ] = Path("./build"),
         build_env_name: Annotated[
-            Optional[str],
+            str | None,
             typer.Option(
                 "--env",
                 "-e",
@@ -342,10 +346,18 @@ class CoreApp(typer.Typer):
             ),
         ] = False,
         include: Annotated[
-            Optional[list[str]],
+            list[str] | None,
             typer.Option(
                 "--include",
-                help=f"Specify which resource types to deploy, supported types: {AVAILABLE_DATA_TYPES}",
+                help=f"Specify which resource types to clean, supported types: {AVAILABLE_DATA_TYPES}",
+            ),
+        ] = None,
+        module: Annotated[
+            str | None,
+            typer.Option(
+                "--module",
+                "-m",
+                help="Specify name or path of the module to clean",
             ),
         ] = None,
         verbose: Annotated[
@@ -368,6 +380,8 @@ class CoreApp(typer.Typer):
                 build_env_name,
                 dry_run,
                 include,
+                module,
                 verbose,
+                all_modules=False,
             )
         )

cognite_toolkit/_cdf_tk/apps/_data_app.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+import typer
+from rich import print
+
+from ._download_app import DownloadApp
+from ._purge import PurgeApp
+from ._upload_app import UploadApp
+
+
+class DataApp(typer.Typer):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.callback(invoke_without_command=True)(self.main)
+        self.add_typer(DownloadApp(*args, **kwargs), name="download")
+        self.add_typer(UploadApp(*args, **kwargs), name="upload")
+        self.add_typer(PurgeApp(*args, **kwargs), name="purge")
+
+    @staticmethod
+    def main(ctx: typer.Context) -> None:
+        """Plugin to work with data in CDF"""
+        if ctx.invoked_subcommand is None:
+            print("Use [bold yellow]cdf data --help[/] for more information.")
+        return None

cognite_toolkit/_cdf_tk/apps/_dev_app.py

@@ -0,0 +1,86 @@
+from pathlib import Path
+from typing import Annotated, Any
+
+import typer
+from rich import print
+
+from cognite_toolkit._cdf_tk.cdf_toml import CDFToml
+from cognite_toolkit._cdf_tk.commands import ResourcesCommand
+from cognite_toolkit._cdf_tk.feature_flags import FeatureFlag, Flags
+
+from ._run import RunApp
+
+CDF_TOML = CDFToml.load(Path.cwd())
+
+
+class DevApp(typer.Typer):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.callback(invoke_without_command=True)(self.main)
+        self.add_typer(RunApp(*args, **kwargs), name="run")
+        if FeatureFlag.is_enabled(Flags.CREATE):
+            self.command("create")(self.create)
+
+    @staticmethod
+    def main(ctx: typer.Context) -> None:
+        """Commands to work with development."""
+        if ctx.invoked_subcommand is None:
+            print("Use [bold yellow]cdf dev --help[/] for more information.")
+        return None
+
+    def create(
+        self,
+        kind: Annotated[
+            list[str] | None,
+            typer.Argument(
+                help="The kind of resource to create. eg. container, space, view, datamodel, etc.",
+                callback=lambda ctx, param, value: [
+                    s.strip() for item in value or [] for s in item.split(",") if s.strip()
+                ],
+            ),
+        ] = None,
+        module: Annotated[
+            str | None,
+            typer.Option(
+                "--module",
+                "-m",
+                help="Name of an existing module or a new module to create the resource in.",
+            ),
+        ] = None,
+        prefix: Annotated[
+            str | None,
+            typer.Option(
+                "--prefix",
+                "-p",
+                help="The prefix of the resource file to create without suffixes and extensions. "
+                "eg. --prefix=my_space. If not provided, a default prefix like 'my_<kind>' will be used.",
+            ),
+        ] = None,
+        verbose: Annotated[
+            bool,
+            typer.Option(
+                "--verbose",
+                "-v",
+                help="Turn on to get more verbose output when running the command",
+            ),
+        ] = False,
+        organization_dir: Annotated[
+            Path,
+            typer.Option(
+                "--organization-dir",
+                "-o",
+                help="Path to the organization directory",
+            ),
+        ] = CDF_TOML.cdf.default_organization_dir,
+    ) -> None:
+        """create resource YAMLs."""
+        cmd = ResourcesCommand()
+        cmd.run(
+            lambda: cmd.create(
+                organization_dir=organization_dir,
+                module_name=module,
+                kind=kind,
+                prefix=prefix,
+                verbose=verbose,
+            )
+        )