cognite-neat 0.94.0__tar.gz → 0.96.0__tar.gz

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cognite-neat
-Version: 0.94.0
+Version: 0.96.0
 Summary: Knowledge graph transformation
 Home-page: https://cognite-neat.readthedocs-hosted.com/
 License: Apache-2.0
@@ -17,7 +17,6 @@ Provides-Extra: all
 Provides-Extra: docs
 Provides-Extra: google
 Provides-Extra: graphql
-Provides-Extra: jupyter
 Provides-Extra: oxi
 Provides-Extra: service
 Requires-Dist: PyYAML
@@ -28,9 +27,7 @@ Requires-Dist: fastapi (>=0,<1) ; extra == "service" or extra == "all"
 Requires-Dist: google-api-python-client ; extra == "google"
 Requires-Dist: google-auth-oauthlib ; extra == "google"
 Requires-Dist: gspread ; extra == "google"
-Requires-Dist: ipycytoscape (>=1.3.3,<2.0.0)
 Requires-Dist: jinja2 (>=3.1.2,<4.0.0) ; extra == "graphql" or extra == "all"
-Requires-Dist: matplotlib (>=3.9.2,<4.0.0)
 Requires-Dist: mkdocs ; extra == "docs"
 Requires-Dist: mkdocs-autorefs (>=0.5.0,<0.6.0) ; extra == "docs"
 Requires-Dist: mkdocs-git-authors-plugin ; extra == "docs"
@@ -49,9 +46,10 @@ Requires-Dist: pydantic (>=2,<3)
 Requires-Dist: pymdown-extensions ; extra == "docs"
 Requires-Dist: pyoxigraph (==0.3.19) ; extra == "oxi" or extra == "all"
 Requires-Dist: python-multipart (==0.0.9) ; extra == "service" or extra == "all"
+Requires-Dist: pyvis (>=0.3.2,<0.4.0)
 Requires-Dist: rdflib
 Requires-Dist: requests
-Requires-Dist: rich[jupyter] (>=13.7.1,<14.0.0) ; extra == "jupyter"
+Requires-Dist: rich[jupyter] (>=13.7.1,<14.0.0)
 Requires-Dist: schedule (>=1,<2) ; extra == "service" or extra == "all"
 Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
 Requires-Dist: typing_extensions (>=4.8,<5.0) ; python_version < "3.11"

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_constants.py

@@ -5,6 +5,22 @@ from rdflib import DCTERMS, OWL, RDF, RDFS, SKOS, XSD, Namespace, URIRef
 
 from cognite import neat
 
+
+def _is_in_notebook() -> bool:
+    try:
+        from IPython import get_ipython
+
+        if "IPKernelApp" not in get_ipython().config:  # pragma: no cover
+            return False
+    except ImportError:
+        return False
+    except AttributeError:
+        return False
+    return True
+
+
+IN_NOTEBOOK = _is_in_notebook()
+
 PACKAGE_DIRECTORY = Path(neat.__file__).parent
 COGNITE_MODELS = (
     DataModelId("cdf_cdm", "CogniteCore", "v1"),

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_issues/_base.py

@@ -11,7 +11,12 @@ from typing import Any, ClassVar, Literal, TypeAlias, TypeVar, get_args, get_ori
 from warnings import WarningMessage
 
 import pandas as pd
-from cognite.client.data_classes.data_modeling import ContainerId, PropertyId, ViewId
+from cognite.client.data_classes.data_modeling import (
+    ContainerId,
+    DataModelId,
+    PropertyId,
+    ViewId,
+)
 from pydantic_core import ErrorDetails
 
 from cognite.neat._utils.spreadsheet import SpreadsheetRead
@@ -67,7 +72,7 @@ class NeatIssue:
     extra: ClassVar[str | None] = None
     fix: ClassVar[str | None] = None
 
-    def as_message(self) -> str:
+    def as_message(self, include_type: bool = True) -> str:
         """Return a human-readable message for the issue."""
         template = self.__doc__
         if not template:
@@ -79,8 +84,10 @@ class NeatIssue:
             msg += "\n" + self.extra.format(**variables)
         if self.fix:
             msg += f"\nFix: {self.fix.format(**variables)}"
-        name = type(self).__name__
-        return f"{name}: {msg}"
+        if include_type:
+            name = type(self).__name__
+            msg = f"{name}: {msg}"
+        return msg
 
     def _get_variables(self) -> tuple[dict[str, str], bool]:
         variables: dict[str, str] = {}
@@ -123,6 +130,8 @@ class NeatIssue:
             return value.dump()
         elif isinstance(value, PropertyId):
             return value.dump(camel_case=True)
+        elif isinstance(value, DataModelId):
+            return value.dump(camel_case=True, include_type=False)
         raise ValueError(f"Unsupported type: {type(value)}")
 
     @classmethod
@@ -169,6 +178,8 @@ class NeatIssue:
             return tuple(cls._load_value(subtype, item) for item in value)
         elif type_ is ViewId:
             return ViewId.load(value)
+        elif type_ is DataModelId:
+            return DataModelId.load(value)
         elif type_ is PropertyId:
             return PropertyId.load(value)
         elif type_ is ContainerId:
@@ -266,7 +277,7 @@ class DefaultPydanticError(NeatError, ValueError):
             msg=error["msg"],
         )
 
-    def as_message(self) -> str:
+    def as_message(self, include_type: bool = True) -> str:
         if self.loc and len(self.loc) == 1:
             return f"{self.loc[0]} sheet: {self.msg}"
         elif self.loc and len(self.loc) == 2:
@@ -307,7 +318,7 @@ class RowError(NeatError, ValueError):
             url=str(url) if (url := error.get("url")) else None,
         )
 
-    def as_message(self) -> str:
+    def as_message(self, include_type: bool = True) -> str:
         input_str = str(self.input) if self.input is not None else ""
         input_str = input_str[:50] + "..." if len(input_str) > 50 else input_str
         output = (
@@ -350,7 +361,7 @@ class DefaultWarning(NeatWarning):
             source=warning.source,
         )
 
-    def as_message(self) -> str:
+    def as_message(self, include_type: bool = True) -> str:
         return str(self.warning)
 
 
@@ -421,7 +432,12 @@ class IssueList(NeatIssueList[NeatIssue]):
     def _repr_html_(self) -> str | None:
         if not self:
             return "<p>'No issues found'</p>"
-        return super()._repr_html_()
+        df = self.to_pandas()
+        agg_df = df["NeatIssue"].value_counts().to_frame()
+        if len(agg_df) < 10:
+            return agg_df._repr_html_()  # type: ignore[operator]
+        else:
+            return agg_df.head()._repr_html_()  # type: ignore[operator]
 
 
 T_Cls = TypeVar("T_Cls")

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_issues/errors/_resources.py

@@ -40,7 +40,7 @@ class ResourceNotFoundError(ResourceError, Generic[T_Identifier, T_ReferenceIden
     referred_type: ResourceType | None = None
     more: str | None = None
 
-    def as_message(self) -> str:
+    def as_message(self, include_type: bool = True) -> str:
         msg = (self.__doc__ or "").format(resource_type=self.resource_type, identifier=self.identifier)
         if self.referred_by and self.referred_type:
             msg += self.extra.format(referred_type=self.referred_type, referred_by=self.referred_by)
@@ -99,7 +99,7 @@ class ResourceChangedError(ResourceError[T_Identifier]):
     changed_properties: frozenset[str]
     changed_attributes: frozenset[str]
 
-    def as_message(self) -> str:
+    def as_message(self, include_type: bool = True) -> str:
         if self.changed_properties:
             changed = f" properties {humanize_collection(self.changed_properties)}."
         elif self.changed_attributes:

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_issues/warnings/_models.py

@@ -2,7 +2,7 @@ from abc import ABC
 from dataclasses import dataclass
 from typing import ClassVar
 
-from cognite.client.data_classes.data_modeling import ViewId
+from cognite.client.data_classes.data_modeling import DataModelId, ViewId
 
 from cognite.neat._constants import DMS_VIEW_CONTAINER_SIZE_LIMIT
 from cognite.neat._issues import NeatWarning
@@ -18,7 +18,7 @@ class BreakingModelingPrincipleWarning(NeatWarning, ABC):
     url: ClassVar[str]
     specific: str
 
-    def as_message(self) -> str:
+    def as_message(self, include_type: bool = True) -> str:
         principle = type(self).__name__.removesuffix("Warning")
         url = f"{_BASE_URL}#{self.url}"
         return (self.__doc__ or "").format(
@@ -90,3 +90,21 @@ class NotSupportedHasDataFilterLimitWarning(CDFNotSupportedWarning):
     view_id: ViewId
     count: int
     limit: int = DMS_VIEW_CONTAINER_SIZE_LIMIT
+
+
+@dataclass(unsafe_hash=True)
+class EnterpriseModelNotBuildOnTopOfCDMWarning(UserModelingWarning):
+    """Enterprise data model being build on top {reference_model_id}. This is not recommended."""
+
+    fix = "Always build Enterprise Data Model on top of Cognite Data Model such as Core Data Model."
+
+    reference_model_id: DataModelId
+
+
+@dataclass(unsafe_hash=True)
+class SolutionModelBuildOnTopOfCDMWarning(UserModelingWarning):
+    """Solution data model being build on top Cognite Data Model {reference_model_id}. This is not recommended."""
+
+    fix = "Always build solution data model on top of enterprise data model."
+
+    reference_model_id: DataModelId

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_rules/exporters/_rules2excel.py

@@ -13,6 +13,7 @@ from openpyxl.styles import Alignment, Border, Font, PatternFill, Side
 from openpyxl.worksheet.worksheet import Worksheet
 from rdflib import Namespace
 
+from cognite.neat._constants import COGNITE_MODELS
 from cognite.neat._rules._shared import VerifiedRules
 from cognite.neat._rules.models import (
     DataModelType,
@@ -21,6 +22,7 @@ from cognite.neat._rules.models import (
     SheetRow,
 )
 from cognite.neat._rules.models.dms import DMSMetadata
+from cognite.neat._rules.models.dms._rules import DMSRules
 from cognite.neat._rules.models.domain import DomainMetadata
 from cognite.neat._rules.models.information import InformationMetadata
 from cognite.neat._rules.models.information._rules import InformationRules
@@ -134,8 +136,12 @@ class ExcelExporter(BaseExporter[VerifiedRules, Workbook]):
             self._write_metadata_sheet(workbook, dumped_last_rules["Metadata"], sheet_prefix="Last")
 
         if dumped_reference_rules:
-            self._write_sheets(workbook, dumped_reference_rules, rules, sheet_prefix="Ref")
-            self._write_metadata_sheet(workbook, dumped_reference_rules["Metadata"], sheet_prefix="Ref")
+            if isinstance(rules.reference, DMSRules):
+                sheet_prefix = "CDM" if rules.reference.metadata.as_data_model_id() in COGNITE_MODELS else "Ref"
+            else:
+                sheet_prefix = "Ref"
+            self._write_sheets(workbook, dumped_reference_rules, rules, sheet_prefix=sheet_prefix)
+            self._write_metadata_sheet(workbook, dumped_reference_rules["Metadata"], sheet_prefix=sheet_prefix)
 
         if isinstance(rules, InformationRules) and rules.prefixes:
             self._write_prefixes_sheet(workbook, rules.prefixes)

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_rules/models/dms/_rules.py

@@ -5,6 +5,7 @@ from collections.abc import Hashable
 from datetime import datetime
 from typing import TYPE_CHECKING, Any, ClassVar, Literal
 
+import pandas as pd
 from cognite.client import data_modeling as dm
 from pydantic import Field, field_serializer, field_validator, model_validator
 from pydantic_core.core_schema import SerializationInfo, ValidationInfo
@@ -451,3 +452,18 @@ class DMSRules(BaseRules):
         from ._exporter import _DMSExporter
 
         return _DMSExporter(self, include_pipeline, instance_space).to_schema()
+
+    def _repr_html_(self) -> str:
+        summary = {
+            "type": "Physical Data Model",
+            "intended for": "DMS Architect",
+            "name": self.metadata.name,
+            "space": self.metadata.space,
+            "external_id": self.metadata.external_id,
+            "version": self.metadata.version,
+            "views": len(self.views),
+            "containers": len(self.containers) if self.containers else 0,
+            "properties": len(self.properties),
+        }
+
+        return pd.DataFrame([summary]).T.rename(columns={0: ""})._repr_html_()  # type: ignore

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_rules/models/dms/_rules_input.py

@@ -3,6 +3,7 @@ from dataclasses import dataclass
 from datetime import datetime
 from typing import Any, Literal
 
+import pandas as pd
 from cognite.client import data_modeling as dm
 
 from cognite.neat._rules.models._base_input import InputComponent, InputRules
@@ -291,3 +292,18 @@ class DMSInputRules(InputRules[DMSRules]):
             "Last": last,
             "Reference": reference,
         }
+
+    def _repr_html_(self) -> str:
+        summary = {
+            "type": "Physical Data Model",
+            "intended for": "DMS Architect",
+            "name": self.metadata.name,
+            "space": self.metadata.space,
+            "external_id": self.metadata.external_id,
+            "version": self.metadata.version,
+            "views": len(self.views),
+            "containers": len(self.containers) if self.containers else 0,
+            "properties": len(self.properties),
+        }
+
+        return pd.DataFrame([summary]).T.rename(columns={0: ""})._repr_html_()  # type: ignore

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_rules/models/information/_rules.py

@@ -4,6 +4,7 @@ from collections.abc import Hashable
 from datetime import datetime
 from typing import TYPE_CHECKING, Any, ClassVar
 
+import pandas as pd
 from pydantic import Field, field_serializer, field_validator, model_validator
 from pydantic_core.core_schema import SerializationInfo
 from rdflib import Namespace
@@ -380,3 +381,16 @@ class InformationRules(BaseRules):
         from cognite.neat._rules.transformers._converters import _InformationRulesConverter
 
         return _InformationRulesConverter(self).as_dms_rules()
+
+    def _repr_html_(self) -> str:
+        summary = {
+            "type": "Logical Data Model",
+            "intended for": "Information Architect",
+            "name": self.metadata.name,
+            "external_id": self.metadata.prefix,
+            "version": self.metadata.version,
+            "classes": len(self.classes),
+            "properties": len(self.properties),
+        }
+
+        return pd.DataFrame([summary]).T.rename(columns={0: ""})._repr_html_()  # type: ignore

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_rules/models/information/_rules_input.py

@@ -2,6 +2,7 @@ from dataclasses import dataclass, field
 from datetime import datetime
 from typing import Any, Literal
 
+import pandas as pd
 from rdflib import Namespace
 
 from cognite.neat._rules.models._base_input import InputComponent, InputRules
@@ -144,3 +145,16 @@ class InformationInputRules(InputRules[InformationRules]):
             Last=last,
             Reference=reference,
         )
+
+    def _repr_html_(self) -> str:
+        summary = {
+            "type": "Logical Data Model",
+            "intended for": "Information Architect",
+            "name": self.metadata.name,
+            "external_id": self.metadata.prefix,
+            "version": self.metadata.version,
+            "classes": len(self.classes),
+            "properties": len(self.properties),
+        }
+
+        return pd.DataFrame([summary]).T.rename(columns={0: ""})._repr_html_()  # type: ignore

{cognite_neat-0.94.0 → cognite_neat-0.96.0}/cognite/neat/_rules/transformers/__init__.py

@@ -6,6 +6,7 @@ from ._converters import (
     InformationToAsset,
     InformationToDMS,
     ReduceCogniteModel,
+    SetIDDMSModel,
     ToCompliantEntities,
     ToExtension,
 )
@@ -31,4 +32,5 @@ __all__ = [
     "RuleMapper",
     "ToExtension",
     "ReduceCogniteModel",
+    "SetIDDMSModel",
 ]