cognite-toolkit 0.6.39__py3-none-any.whl → 0.7.30__py3-none-any.whl

cognite_toolkit/_cdf.py

@@ -24,21 +24,19 @@ from rich import print
 from cognite_toolkit._cdf_tk.apps import (
     AuthApp,
     CoreApp,
-    DownloadApp,
+    DataApp,
+    DevApp,
     DumpApp,
     LandingApp,
     MigrateApp,
     ModulesApp,
-    PopulateApp,
     ProfileApp,
-    PurgeApp,
     RepoApp,
     RunApp,
-    UploadApp,
 )
 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 (
@@ -91,18 +89,18 @@ user_app = typer.Typer(**default_typer_kws, hidden=True)  # type: ignore [arg-ty
 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")
@@ -110,16 +108,20 @@ if Flags.PROFILE.is_enabled():
 if Flags.MIGRATE.is_enabled():
     _app.add_typer(MigrateApp(**default_typer_kws), name="migrate")
 
-if Flags.DOWNLOAD.is_enabled():
-    _app.add_typer(DownloadApp(**default_typer_kws), name="download")
-
-if Flags.UPLOAD.is_enabled():
-    _app.add_typer(UploadApp(**default_typer_kws), name="upload")
+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:
@@ -152,17 +154,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,11 +1,12 @@
 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 ._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
@@ -15,12 +16,13 @@ from ._upload_app import UploadApp
 __all__ = [
     "AuthApp",
     "CoreApp",
+    "DataApp",
+    "DevApp",
     "DownloadApp",
     "DumpApp",
     "LandingApp",
     "MigrateApp",
     "ModulesApp",
-    "PopulateApp",
     "ProfileApp",
     "PurgeApp",
     "RepoApp",

cognite_toolkit/_cdf_tk/apps/_core_app.py

@@ -15,7 +15,6 @@ from cognite_toolkit._cdf_tk.client import ToolkitClient
 from cognite_toolkit._cdf_tk.commands import BuildCommand, CleanCommand, DeployCommand
 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
 from cognite_toolkit._cdf_tk.utils import get_cicd_environment
 from cognite_toolkit._cdf_tk.utils.auth import EnvironmentVariables
 from cognite_toolkit._version import __version__ as current_version
@@ -77,7 +76,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 +88,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.",
@@ -193,7 +192,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,7 +204,7 @@ 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)
@@ -223,7 +221,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:
@@ -345,7 +343,15 @@ class CoreApp(typer.Typer):
             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 +374,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,
+            )
+        )