cognite-toolkit 0.7.2__tar.gz → 0.7.4__tar.gz

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite_toolkit
-Version: 0.7.2
+Version: 0.7.4
 Summary: Official Cognite Data Fusion tool for project templates and configuration deployment
 Project-URL: Homepage, https://docs.cognite.com/cdf/deploy/cdf_toolkit/
 Project-URL: Changelog, https://github.com/cognitedata/toolkit/releases

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cdf.toml

@@ -11,6 +11,7 @@ profile = true
 infield = true
 migrate = true
 streams = true
+create = true
 
 [plugins]
 run = true
@@ -21,7 +22,7 @@ data = true
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.7.2"
+version = "0.7.4"
 
 
 [library.toolkit-data]

cognite_toolkit-0.7.4/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,
+            )
+        )

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cognite_toolkit/_cdf_tk/commands/__init__.py

@@ -17,6 +17,7 @@ from .init import InitCommand
 from .modules import ModulesCommand
 from .pull import PullCommand
 from .repo import RepoCommand
+from .resources import ResourcesCommand
 from .run import RunFunctionCommand, RunTransformationCommand, RunWorkflowCommand
 
 __all__ = [
@@ -39,6 +40,7 @@ __all__ = [
     "PullCommand",
     "PurgeCommand",
     "RepoCommand",
+    "ResourcesCommand",
     "RunFunctionCommand",
     "RunTransformationCommand",
     "RunWorkflowCommand",

cognite_toolkit-0.7.4/cognite_toolkit/_cdf_tk/commands/resources.py

@@ -0,0 +1,179 @@
+import difflib
+from pathlib import Path
+from typing import cast
+
+import questionary
+import typer
+from questionary import Choice
+from rich import print
+
+from cognite_toolkit._cdf_tk.commands._base import ToolkitCommand
+from cognite_toolkit._cdf_tk.constants import MODULES
+from cognite_toolkit._cdf_tk.cruds import RESOURCE_CRUD_LIST, ResourceCRUD
+from cognite_toolkit._cdf_tk.data_classes import ModuleDirectories
+from cognite_toolkit._cdf_tk.resource_classes import ToolkitResource
+from cognite_toolkit._cdf_tk.utils.collection import humanize_collection
+from cognite_toolkit._cdf_tk.utils.file import yaml_safe_dump
+
+
+class ResourcesCommand(ToolkitCommand):
+    def __init__(self, print_warning: bool = True, skip_tracking: bool = False, silent: bool = False) -> None:
+        super().__init__(print_warning, skip_tracking, silent)
+
+    def _get_or_prompt_module_path(self, module: str | None, organization_dir: Path, verbose: bool) -> Path:
+        """
+        Check if the module exists in the organization directory and return the module path.
+        If module is not provided, ask the user to select or create a new module.
+        """
+        present_modules = ModuleDirectories.load(organization_dir, None)
+
+        if module:
+            for mod in present_modules:
+                if mod.name.casefold() == module.casefold():
+                    return mod.dir
+
+            if questionary.confirm(f"{module} module not found. Do you want to create a new one?").ask():
+                return organization_dir / MODULES / module
+
+            if verbose:
+                print(f"[red]Aborting as {module} module not found...[/red]")
+            else:
+                print("[red]Aborting...[/red]")
+            raise typer.Exit()
+
+        choices = [Choice(title=mod.name, value=mod.dir) for mod in present_modules]
+        choices.append(Choice(title="<Create new module>", value="NEW"))
+
+        selected = questionary.select("Select a module:", choices=choices).ask()
+
+        if selected == "NEW":
+            new_module_name = questionary.text("Enter name for new module:").ask()
+            if not new_module_name:
+                print("[red]No module name provided. Aborting...[/red]")
+                raise typer.Exit()
+            return organization_dir / MODULES / new_module_name
+
+        if not selected:
+            print("[red]No module selected. Aborting...[/red]")
+            raise typer.Exit()
+
+        return cast(Path, selected)
+
+    def _resolve_kinds(self, kinds: list[str] | None) -> list[type[ResourceCRUD]]:
+        """
+        Resolve kinds from list of strings or do an interactive selection.
+        """
+        all_cruds = {crud.kind.casefold(): crud for crud in RESOURCE_CRUD_LIST}
+
+        if not kinds:
+            sorted_cruds = sorted(RESOURCE_CRUD_LIST, key=lambda x: x.kind)
+            choices = [Choice(title=crud.kind, value=crud) for crud in sorted_cruds]
+
+            selected = questionary.select("Select resource type:", choices=choices).ask()
+            if not selected:
+                print("[red]No resource type selected. Aborting...[/red]")
+                raise typer.Exit()
+            return [selected]
+
+        resolved_cruds = []
+        for kind in kinds:
+            kind_lower = kind.casefold()
+            if kind_lower in all_cruds:
+                resolved_cruds.append(all_cruds[kind_lower])
+            else:
+                matches = difflib.get_close_matches(kind_lower, all_cruds.keys())
+                if matches:
+                    suggestion = all_cruds[matches[0]].kind
+                    print(f"[red]Unknown resource type '{kind}'. Did you mean '{suggestion}'?[/red]")
+                else:
+                    print(
+                        f"[red]Unknown resource type '{kind}'. "
+                        f"Available types: {humanize_collection(sorted([c.kind for c in RESOURCE_CRUD_LIST]))}[/red]"
+                    )
+                raise typer.Exit()
+
+        return resolved_cruds
+
+    def _create_resource_yaml_skeleton(self, yaml_cls: type[ToolkitResource]) -> dict[str, str]:
+        """
+        Build YAML skeleton from a Pydantic model class using JSON schema for better type information.
+        """
+        yaml_skeleton: dict[str, str] = {}
+        for field_name, field in yaml_cls.model_fields.items():
+            name = field.alias or field_name
+            description = field.description or name
+            if field.is_required():
+                yaml_skeleton[name] = f"(Required) {description}"
+            else:
+                yaml_skeleton[name] = description
+
+        return yaml_skeleton
+
+    def _get_resource_yaml_content(self, resource_crud: type[ResourceCRUD]) -> str:
+        """
+        Creates a new resource in the specified module using the resource_crud.yaml_cls.
+        """
+        yaml_header = (
+            f"# API docs: {resource_crud.doc_url()}\n"
+            f"# YAML reference: https://docs.cognite.com/cdf/deploy/cdf_toolkit/references/resource_library"
+        )
+        yaml_skeleton = self._create_resource_yaml_skeleton(resource_crud.yaml_cls)
+        yaml_contents = yaml_safe_dump(yaml_skeleton)
+        return yaml_header + "\n\n" + yaml_contents
+
+    def _create_resource_yaml_file(
+        self,
+        resource_crud: type[ResourceCRUD],
+        module_path: Path,
+        prefix: str | None = None,
+        verbose: bool = False,
+    ) -> None:
+        """
+        Creates a new resource YAML file in the specified module using the resource_crud.yaml_cls.
+        """
+        resource_dir: Path = module_path / resource_crud.folder_name
+        if resource_crud.sub_folder_name:
+            resource_dir = resource_dir / resource_crud.sub_folder_name
+
+        if not resource_dir.exists():
+            resource_dir.mkdir(parents=True, exist_ok=True)
+
+        final_prefix = prefix if prefix is not None else f"my_{resource_crud.kind}"
+        file_name = f"{final_prefix}.{resource_crud.kind}.yaml"
+        file_path: Path = resource_dir / file_name
+
+        if file_path.exists() and not questionary.confirm(f"{file_path.name} file already exists. Overwrite?").ask():
+            print("[red]Skipping...[/red]")
+            return
+
+        yaml_content = self._get_resource_yaml_content(resource_crud)
+        file_path.write_text(yaml_content)
+        if verbose:
+            print(
+                f"[green]{resource_crud.kind} Resource YAML file created successfully at {file_path.as_posix()}[/green]"
+            )
+        else:
+            print(f"[green]Created {file_path.as_posix()}[/green]")
+
+    def create(
+        self,
+        organization_dir: Path,
+        module_name: str | None = None,
+        kind: list[str] | None = None,
+        prefix: str | None = None,
+        verbose: bool = False,
+    ) -> None:
+        """
+        create resource YAMLs.
+
+        Args:
+            organization_dir: The directory of the organization.
+            module_name: The name of the module.
+            kind: The kind(s) of resource to create.
+            prefix: The prefix for the resource file.
+            verbose: Whether to print verbose output.
+        """
+        module_path = self._get_or_prompt_module_path(module_name, organization_dir, verbose)
+        resource_cruds = self._resolve_kinds(kind)
+        for crud in resource_cruds:
+            self._create_resource_yaml_file(crud, module_path, prefix, verbose)

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cognite_toolkit/_cdf_tk/cruds/_base_cruds.py

@@ -54,6 +54,7 @@ class Loader(ABC):
     exclude_filetypes: frozenset[str] = frozenset()
     _doc_base_url: str = "https://api-docs.cognite.com/20230101/tag/"
     _doc_url: str = ""
+    sub_folder_name: str | None = None
 
     def __init__(self, client: ToolkitClient, build_dir: Path | None, console: Console | None = None) -> None:
         self.client = client

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cognite_toolkit/_cdf_tk/cruds/_resource_cruds/datamodel.py

@@ -262,6 +262,7 @@ class ContainerCRUD(ResourceContainerCRUD[ContainerId, ContainerApply, Container
     dependencies = frozenset({SpaceCRUD})
     yaml_cls = ContainerYAML
     _doc_url = "Containers/operation/ApplyContainers"
+    sub_folder_name = "containers"
 
     def __init__(
         self,
@@ -526,6 +527,7 @@ class ViewCRUD(ResourceCRUD[ViewId, ViewApply, View, ViewApplyList, ViewList]):
     dependencies = frozenset({SpaceCRUD, ContainerCRUD})
     yaml_cls = ViewYAML
     _doc_url = "Views/operation/ApplyViews"
+    sub_folder_name = "views"
 
     def __init__(
         self,
@@ -1001,6 +1003,7 @@ class NodeCRUD(ResourceContainerCRUD[NodeId, NodeApply, Node, NodeApplyList, Nod
     yaml_cls = NodeYAML
     dependencies = frozenset({SpaceCRUD, ViewCRUD, ContainerCRUD})
     _doc_url = "Instances/operation/applyNodeAndEdges"
+    sub_folder_name = "nodes"
 
     def __init__(
         self,

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cognite_toolkit/_cdf_tk/feature_flags.py

@@ -49,6 +49,10 @@ class Flags(Enum):
         visible=False,
         description="Enables features planned for Cognite Toolkit version 0.8.0",
     )
+    CREATE = FlagMetadata(
+        visible=True,
+        description="Enables the support for the resources create command under dev plugin",
+    )
 
     def is_enabled(self) -> bool:
         return FeatureFlag.is_enabled(self)

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cognite_toolkit/_cdf_tk/resource_classes/capabilities.py

@@ -510,6 +510,18 @@ class LegacyGenericsAcl(Capability):
     scope: AllScope
 
 
+class StreamsAcl(Capability):
+    _capability_name = "streamsAcl"
+    actions: list[Literal["READ", "CREATE", "DELETE"]]
+    scope: AllScope
+
+
+class StreamRecordsAcl(Capability):
+    _capability_name = "streamRecordsAcl"
+    actions: list[Literal["READ", "WRITE"]]
+    scope: AllScope | SpaceIDScope
+
+
 _CAPABILITY_CLASS_BY_NAME: MappingProxyType[str, type[Capability]] = MappingProxyType(
     {c._capability_name: c for c in Capability.__subclasses__()}
 )

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cognite_toolkit/_repo_files/GitHub/.github/workflows/deploy.yaml

@@ -12,7 +12,7 @@ jobs:
     environment: dev
     name: Deploy
     container:
-      image: cognite/toolkit:0.7.2
+      image: cognite/toolkit:0.7.4
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cognite_toolkit/_repo_files/GitHub/.github/workflows/dry-run.yaml

@@ -10,7 +10,7 @@ jobs:
     environment: dev
     name: Deploy Dry Run
     container:
-      image: cognite/toolkit:0.7.2
+      image: cognite/toolkit:0.7.4
       env:
         CDF_CLUSTER: ${{ vars.CDF_CLUSTER }}
         CDF_PROJECT: ${{ vars.CDF_PROJECT }}

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/cognite_toolkit/_resources/cdf.toml

@@ -4,7 +4,7 @@ default_env = "<DEFAULT_ENV_PLACEHOLDER>"
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.7.2"
+version = "0.7.4"
 
 
 [plugins]

cognite_toolkit-0.7.4/cognite_toolkit/_version.py

@@ -0,0 +1 @@
+__version__ = "0.7.4"

cognite_toolkit-0.7.4/last_changelog_entry.md

@@ -0,0 +1,6 @@
+## Changelog 
+
+### Added
+
+- `StreamsAcl` and `StreamRecordsAcl` class in capabilities for
+`GroupYAML`

cognite_toolkit-0.7.4/last_git_message.txt

@@ -0,0 +1,20 @@
+[CDF-26448] 🐛 Stream and Record capability bug fix in GroupYAML (#2252)
+
+# Description
+
+`StreamsAcl` and `StreamRecordsAcl` were not defined in
+`capabilities.py`. Due to this users were facing invalid capability
+warning. This PR intends to fix that by adding these capabilities and
+making it available to `GroupYAML` resource class for validation.
+
+## Bump
+
+- [x] Patch
+- [ ] Skip
+
+## Changelog
+
+### Added
+
+- `StreamsAcl` and `StreamRecordsAcl` class in capabilities for
+`GroupYAML`

cognite_toolkit-0.7.4/last_version.txt

@@ -0,0 +1 @@
+0.7.3

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cognite_toolkit"
-version = "0.7.2"
+version = "0.7.4"
 description = "Official Cognite Data Fusion tool for project templates and configuration deployment"
 authors = [
     {name ="Cognite AS", email="support@cognite.com"}

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/tests/data/build_group_with_unknown_acl/_build_environment.yaml

@@ -4,4 +4,4 @@ project: pytest-project
 type: dev
 selected:
 - modules
-cdf_toolkit_version: 0.7.2
+cdf_toolkit_version: 0.7.4

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/tests/data/cdf_toml_data/cdf.toml

@@ -1,7 +1,7 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.7.2"
+version = "0.7.4"
 
 [plugins]
 graphql = true

{cognite_toolkit-0.7.2/tests/data/complete_org_alpha_flags → cognite_toolkit-0.7.4/tests/data/complete_org}/cdf.toml

@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.7.2"
+version = "0.7.4"

{cognite_toolkit-0.7.2/tests/data/complete_org_only_identifier → cognite_toolkit-0.7.4/tests/data/complete_org_alpha_flags}/cdf.toml

@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.7.2"
+version = "0.7.4"

{cognite_toolkit-0.7.2/tests/data/naughty_project → cognite_toolkit-0.7.4/tests/data/complete_org_only_identifier}/cdf.toml

@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.7.2"
+version = "0.7.4"

{cognite_toolkit-0.7.2/tests/data/complete_org → cognite_toolkit-0.7.4/tests/data/naughty_project}/cdf.toml

@@ -1,4 +1,4 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.7.2"
+version = "0.7.4"

cognite_toolkit-0.7.4/tests/data/project_no_cognite_modules/cdf.toml

@@ -0,0 +1,4 @@
+[modules]
+# This is the version of the modules. It should not be changed manually.
+# It will be updated by the 'cdf modules upgrade' command.
+version = "0.7.4"

cognite_toolkit-0.7.4/tests/data/project_with_bad_modules/cdf.toml

@@ -0,0 +1,4 @@
+[modules]
+# This is the version of the modules. It should not be changed manually.
+# It will be updated by the 'cdf modules upgrade' command.
+version = "0.7.4"

cognite_toolkit-0.7.4/tests/data/project_with_duplicates/cdf.toml

@@ -0,0 +1,4 @@
+[modules]
+# This is the version of the modules. It should not be changed manually.
+# It will be updated by the 'cdf modules upgrade' command.
+version = "0.7.4"

{cognite_toolkit-0.7.2 → cognite_toolkit-0.7.4}/tests/data/run_data/cdf.toml

@@ -1,7 +1,7 @@
 [modules]
 # This is the version of the modules. It should not be changed manually.
 # It will be updated by the 'cdf modules upgrade' command.
-version = "0.7.2"
+version = "0.7.4"
 
 [modules.packages]
 cdf_infield = [