cognite-neat 0.75.8__py3-none-any.whl → 0.75.9__py3-none-any.whl

cognite/neat/legacy/workflows/examples/Ontology_to_Data_Model/workflow.yaml

@@ -0,0 +1,116 @@
+configs: []
+description: null
+implementation_module: null
+name: Ontology to Data Model
+steps:
+  - complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_trigger
+    label: Trigger
+    max_retries: 0
+    method: null
+    params: {}
+    retry_delay: 3
+    stype: http_trigger
+    system_component_id: null
+    transition_to:
+      - step_128344
+      - dowload_ontology
+    trigger: true
+    ui_config:
+      pos_x: 524
+      pos_y: 259
+  - complex_configs: {}
+    configs:
+      excel_file_path: rules/LIS-14-rules.xlsx
+      make_compliant: "True"
+      ontology_file_path: staging/LIS-14.ttl
+    description: null
+    enabled: true
+    id: onotology2rules
+    label: Import Ontology to Rules
+    max_retries: 0
+    method: ImportOntologyToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - load_generated_rules
+      - import_generated_rules
+    trigger: false
+    ui_config:
+      pos_x: 524
+      pos_y: 403
+  - complex_configs: {}
+    configs:
+      file_name: LIS-14-rules.xlsx
+      validation_report_file: rules_validation_report.txt
+      validation_report_storage_dir: rules_validation_report
+      version: ""
+    description: null
+    enabled: true
+    id: import_generated_rules
+    label: Import Generated Rules
+    max_retries: 0
+    method: ImportExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - step_59017
+      - step_829062
+      - export_rules_to_graphql_schema
+    trigger: false
+    ui_config:
+      pos_x: 524
+      pos_y: 490
+  - complex_configs: {}
+    configs:
+      api_url: https://rds.posccaesar.org/ontology/lis14/ont/core/2.0/LIS-14.ttl
+      auth_mode: none
+      http_method: GET
+      output_file_path: staging/LIS-14.ttl
+      password: ""
+      response_destination: file
+      token: ""
+      username: ""
+    description: null
+    enabled: true
+    id: dowload_ontology
+    label: Download Ontology
+    max_retries: 0
+    method: DownloadDataFromRestApiToFile
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - onotology2rules
+    trigger: false
+    ui_config:
+      pos_x: 524
+      pos_y: 333
+  - complex_configs: {}
+    configs:
+      file_name: ""
+      storage_dir: staging
+    description: null
+    enabled: true
+    id: export_rules_to_graphql_schema
+    label: Export Rules to GraphQL Schema
+    max_retries: 0
+    method: ExportRulesToGraphQLSchema
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+      pos_x: 525
+      pos_y: 577
+system_components: []

cognite/neat/legacy/workflows/examples/Validate_Rules/workflow.yaml

@@ -0,0 +1,67 @@
+configs: []
+description: null
+implementation_module: null
+name: Validate Rules
+steps:
+-   complex_configs: {}
+    configs:
+        File name: ''
+        Report formatter: BasicHTML
+        Role: infer
+    description: null
+    enabled: true
+    id: step_validate_rules
+    label: Validate Rules
+    max_retries: 0
+    method: ExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_942973
+    - step_715590
+    trigger: false
+    ui_config:
+        pos_x: 558
+        pos_y: 97
+-   complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_upload_rules
+    label: Upload Rules Spreadsheets
+    max_retries: 0
+    method: null
+    params:
+        file_type: rules
+    retry_delay: 3
+    stype: file_uploader
+    system_component_id: null
+    transition_to:
+    - step_31642
+    - step_validate_rules
+    trigger: true
+    ui_config:
+        pos_x: 558
+        pos_y: -14
+-   complex_configs: {}
+    configs:
+        Output role format: input
+        Styling: default
+    description: null
+    enabled: true
+    id: step_715590
+    label: Convert Rules
+    max_retries: 0
+    method: RulesToExcel
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+        pos_x: 558
+        pos_y: 217
+system_components: []

cognite/neat/legacy/workflows/examples/Validate_Solution_Model/workflow.yaml

@@ -0,0 +1,64 @@
+configs: []
+description: null
+implementation_module: null
+name: Validate Solution Model
+steps:
+-   complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_769298
+    label: Upload File
+    max_retries: 0
+    method: null
+    params:
+        file_type: rules
+    retry_delay: 3
+    stype: file_uploader
+    system_component_id: null
+    transition_to:
+    - step_399494
+    trigger: true
+    ui_config:
+        pos_x: 627
+        pos_y: -19
+-   complex_configs: {}
+    configs:
+        File name: ''
+        Report formatter: BasicHTML
+        Role: infer
+    description: null
+    enabled: true
+    id: step_399494
+    label: Import Excel
+    max_retries: 0
+    method: ExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_273233
+    trigger: false
+    ui_config:
+        pos_x: 627
+        pos_y: 66
+-   complex_configs: {}
+    configs:
+        Report Formatter: BasicHTML
+    description: null
+    enabled: true
+    id: step_273233
+    label: Validate Against CDF
+    max_retries: 0
+    method: ValidateRulesAgainstCDF
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+        pos_x: 627
+        pos_y: 154
+system_components: []

cognite/neat/legacy/workflows/examples/Visualize_Data_Model_Using_Mock_Graph/workflow.yaml

@@ -0,0 +1,95 @@
+configs: []
+description: null
+implementation_module: null
+name: Visualize Data Model Using Mock Graph
+steps:
+  - complex_configs: {}
+    configs:
+      File name: information-architect-david.xlsx
+      Report formatter: BasicHTML
+      Role: infer
+    description: null
+    enabled: true
+    id: step_verify_rules
+    label: Verify Rules
+    max_retries: 0
+    method: ExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - step_configure_graph_store
+    trigger: false
+    ui_config:
+      pos_x: 507
+      pos_y: 250
+  - complex_configs: {}
+    configs:
+      Disk storage directory: mock-graph-store
+      Graph: source
+      Graph store type: oxigraph
+      GraphDB API root URL: ""
+      Init procedure: reset
+      Query URL: ""
+      Update URL: ""
+    description: null
+    enabled: true
+    id: step_configure_graph_store
+    label: Configure Graph Store
+    max_retries: 0
+    method: GraphStoreConfiguration
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+      - step_166101
+      - step_mock_graph_generation
+    trigger: false
+    ui_config:
+      pos_x: 506
+      pos_y: 314
+  - complex_configs: {}
+    configs:
+      Class count:
+        '{"WindTurbine" : 1, "WindFarm" : 1, "OffshoreSubstation" : 1,
+        "DistributionSubstation" : 1, "OnshoreSubstation" : 1, "ArrayCable" :
+        1, "ExportCable" : 1, "Transmission" : 1, "DistributionLine" : 1, "Meter"
+        : 1, "ElectricCarCharger" : 1}'
+      Graph: source
+    description: null
+    enabled: true
+    id: step_mock_graph_generation
+    label: Generate Mock Graph
+    max_retries: 0
+    method: GraphFromMockData
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+      pos_x: 506
+      pos_y: 390
+  - complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_upload_rules
+    label: Upload Rules
+    max_retries: 0
+    method: null
+    params:
+      file_type: rules
+    retry_delay: 3
+    stype: file_uploader
+    system_component_id: null
+    transition_to:
+      - step_verify_rules
+    trigger: true
+    ui_config:
+      pos_x: 507
+      pos_y: 177
+system_components: []

cognite/neat/legacy/workflows/examples/Visualize_Semantic_Data_Model/workflow.yaml

@@ -0,0 +1,111 @@
+configs: []
+description: null
+implementation_module: null
+name: Visualize Semantic Data Model
+steps:
+-   complex_configs: {}
+    configs: {}
+    description: null
+    enabled: true
+    id: step_upload_excel_rules
+    label: Upload Excel Rules
+    max_retries: 0
+    method: null
+    params:
+        file_type: rules
+    retry_delay: 3
+    stype: file_uploader
+    system_component_id: null
+    transition_to:
+    - step_421523
+    - step_excel_to_rules
+    trigger: true
+    ui_config:
+        pos_x: 498
+        pos_y: 149
+-   complex_configs: {}
+    configs:
+        File name: ''
+        Report formatter: BasicHTML
+        Role: infer
+    description: null
+    enabled: true
+    id: step_excel_to_rules
+    label: Import and Validate Rules
+    max_retries: 0
+    method: ExcelToRules
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_rules_to_ontology
+    trigger: false
+    ui_config:
+        pos_x: 497
+        pos_y: 234
+-   complex_configs: {}
+    configs:
+        File path: staging/semantic-data-model.ttl
+    description: null
+    enabled: true
+    id: step_rules_to_ontology
+    label: Rules to Ontology
+    max_retries: 0
+    method: RulesToSemanticDataModel
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_configure_graph_store
+    trigger: false
+    ui_config:
+        pos_x: 497
+        pos_y: 323
+-   complex_configs: {}
+    configs:
+        Disk storage directory: semantic-data-model
+        Graph: source
+        Graph store type: oxigraph
+        GraphDB API root URL: ''
+        Init procedure: reset
+        Query URL: ''
+        Update URL: ''
+    description: null
+    enabled: true
+    id: step_configure_graph_store
+    label: Configure Graph Store
+    max_retries: 0
+    method: GraphStoreConfiguration
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to:
+    - step_load_semantic_data_model
+    trigger: false
+    ui_config:
+        pos_x: 495
+        pos_y: 399
+-   complex_configs: {}
+    configs:
+        Add base URI: 'False'
+        File path: staging/semantic-data-model.ttl
+        MIME type: text/turtle
+    description: null
+    enabled: true
+    id: step_load_semantic_data_model
+    label: Load Semantic Data Model
+    max_retries: 0
+    method: GraphFromRdfFile
+    params: {}
+    retry_delay: 3
+    stype: stdstep
+    system_component_id: null
+    transition_to: []
+    trigger: false
+    ui_config:
+        pos_x: 495
+        pos_y: 476
+system_components: []

cognite/neat/rules/exporters/_rules2excel.py

@@ -205,8 +205,8 @@ class ExcelExporter(BaseExporter[Workbook]):
 
     @classmethod
     def _adjust_column_widths(cls, workbook: Workbook) -> None:
-        for sheet in workbook:
-            sheet = cast(Worksheet, sheet)
+        for sheet_ in workbook:
+            sheet = cast(Worksheet, sheet_)
             for column_cells in sheet.columns:
                 try:
                     max_length = max(len(str(cell.value)) for cell in column_cells if cell.value is not None)

cognite/neat/rules/exporters/_validation.py

@@ -9,13 +9,13 @@ from cognite.neat.rules.models.rules._types._base import DMS_PROPERTY_ID_COMPLIA
 
 
 @overload
-def are_entity_names_dms_compliant(rules: InformationRules, return_report: Literal[True]) -> tuple[bool, list[dict]]:
-    ...
+def are_entity_names_dms_compliant(
+    rules: InformationRules, return_report: Literal[True]
+) -> tuple[bool, list[dict]]: ...
 
 
 @overload
-def are_entity_names_dms_compliant(rules: InformationRules, return_report: Literal[False] = False) -> bool:
-    ...
+def are_entity_names_dms_compliant(rules: InformationRules, return_report: Literal[False] = False) -> bool: ...
 
 
 def are_entity_names_dms_compliant(
@@ -66,13 +66,11 @@ def are_entity_names_dms_compliant(
 
 
 @overload
-def are_properties_redefined(rules: InformationRules, return_report: Literal[True]) -> tuple[bool, list[dict]]:
-    ...
+def are_properties_redefined(rules: InformationRules, return_report: Literal[True]) -> tuple[bool, list[dict]]: ...
 
 
 @overload
-def are_properties_redefined(rules: InformationRules, return_report: Literal[False] = False) -> bool:
-    ...
+def are_properties_redefined(rules: InformationRules, return_report: Literal[False] = False) -> bool: ...
 
 
 def are_properties_redefined(rules: InformationRules, return_report: bool = False) -> bool | tuple[bool, list[dict]]:

cognite/neat/rules/importers/_base.py

@@ -20,14 +20,12 @@ class BaseImporter(ABC):
     """
 
     @overload
-    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules:
-        ...
+    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
 
     @overload
     def to_rules(
         self, errors: Literal["continue"] = "continue", role: RoleTypes | None = None
-    ) -> tuple[Rules | None, IssueList]:
-        ...
+    ) -> tuple[Rules | None, IssueList]: ...
 
     @abstractmethod
     def to_rules(

cognite/neat/rules/importers/_dms2rules.py

@@ -81,14 +81,12 @@ class DMSImporter(BaseImporter):
         return cls(DMSSchema.from_zip(zip_file))
 
     @overload
-    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules:
-        ...
+    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
 
     @overload
     def to_rules(
         self, errors: Literal["continue"] = "continue", role: RoleTypes | None = None
-    ) -> tuple[Rules | None, IssueList]:
-        ...
+    ) -> tuple[Rules | None, IssueList]: ...
 
     def to_rules(
         self, errors: Literal["raise", "continue"] = "continue", role: RoleTypes | None = None

cognite/neat/rules/importers/_dtdl2rules/dtdl_importer.py

@@ -119,14 +119,12 @@ class DTDLImporter(BaseImporter):
         return cls(items, zip_file.stem, read_issues=issues)
 
     @overload
-    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules:
-        ...
+    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
 
     @overload
     def to_rules(
         self, errors: Literal["continue"] = "continue", role: RoleTypes | None = None
-    ) -> tuple[Rules | None, IssueList]:
-        ...
+    ) -> tuple[Rules | None, IssueList]: ...
 
     def to_rules(
         self, errors: Literal["raise", "continue"] = "continue", role: RoleTypes | None = None

cognite/neat/rules/importers/_dtdl2rules/spec.py

@@ -72,8 +72,7 @@ class DTMI(BaseModel):
             exclude_none: bool = False,
             round_trip: bool = False,
             warnings: bool = True,
-        ) -> str:
-            ...
+        ) -> str: ...
 
 
 IRI: TypeAlias = str
@@ -124,8 +123,7 @@ class Unit(BaseModel, ABC):
             exclude_none: bool = False,
             round_trip: bool = False,
             warnings: bool = True,
-        ) -> str:
-            ...
+        ) -> str: ...
 
 
 class DTDLBase(BaseModel, ABC):

cognite/neat/rules/importers/_owl2rules/_owl2rules.py

@@ -43,14 +43,12 @@ class OWLImporter(BaseImporter):
         self.make_compliant = make_compliant
 
     @overload
-    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules:
-        ...
+    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
 
     @overload
     def to_rules(
         self, errors: Literal["continue"] = "continue", role: RoleTypes | None = None
-    ) -> tuple[Rules | None, IssueList]:
-        ...
+    ) -> tuple[Rules | None, IssueList]: ...
 
     def to_rules(
         self, errors: Literal["raise", "continue"] = "continue", role: RoleTypes | None = None

cognite/neat/rules/importers/_spreadsheet2rules.py

@@ -153,16 +153,14 @@ class ExcelImporter(BaseImporter):
         self.filepath = filepath
 
     @overload
-    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules:
-        ...
+    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
 
     @overload
     def to_rules(
         self,
         errors: Literal["continue"] = "continue",
         role: RoleTypes | None = None,
-    ) -> tuple[Rules | None, IssueList]:
-        ...
+    ) -> tuple[Rules | None, IssueList]: ...
 
     def to_rules(
         self, errors: Literal["raise", "continue"] = "continue", role: RoleTypes | None = None
@@ -244,14 +242,12 @@ class GoogleSheetImporter(BaseImporter):
         self.skiprows = skiprows
 
     @overload
-    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules:
-        ...
+    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
 
     @overload
     def to_rules(
         self, errors: Literal["continue"] = "continue", role: RoleTypes | None = None
-    ) -> tuple[Rules | None, IssueList]:
-        ...
+    ) -> tuple[Rules | None, IssueList]: ...
 
     def to_rules(
         self, errors: Literal["raise", "continue"] = "continue", role: RoleTypes | None = None

cognite/neat/rules/importers/_yaml2rules.py

@@ -46,14 +46,12 @@ class YAMLImporter(BaseImporter):
         return cls(yaml.safe_load(filepath.read_text()), filepaths=[filepath])
 
     @overload
-    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules:
-        ...
+    def to_rules(self, errors: Literal["raise"], role: RoleTypes | None = None) -> Rules: ...
 
     @overload
     def to_rules(
         self, errors: Literal["continue"] = "continue", role: RoleTypes | None = None
-    ) -> tuple[Rules | None, IssueList]:
-        ...
+    ) -> tuple[Rules | None, IssueList]: ...
 
     def to_rules(
         self, errors: Literal["raise", "continue"] = "continue", role: RoleTypes | None = None

cognite/neat/rules/issues/dms.py

@@ -32,13 +32,11 @@ __all__ = [
 
 
 @dataclass(frozen=True)
-class DMSSchemaError(NeatValidationError, ABC):
-    ...
+class DMSSchemaError(NeatValidationError, ABC): ...
 
 
 @dataclass(frozen=True)
-class DMSSchemaWarning(ValidationWarning, ABC):
-    ...
+class DMSSchemaWarning(ValidationWarning, ABC): ...
 
 
 @dataclass(frozen=True)

cognite/neat/rules/issues/formatters.py

@@ -79,5 +79,7 @@ class BasicHTML(Formatter):
 
 
 FORMATTER_BY_NAME: dict[str, type[Formatter]] = {
-    subclass.__name__: subclass for subclass in Formatter.__subclasses__() if ABC not in subclass.__bases__  # type: ignore[type-abstract]
+    subclass.__name__: subclass  # type: ignore[type-abstract]
+    for subclass in Formatter.__subclasses__()
+    if ABC not in subclass.__bases__  # type: ignore[type-abstract]
 }

cognite/neat/rules/models/entities.py

@@ -57,8 +57,7 @@ _PROPERTY_ID_REGEX = rf"\((?P<{EntityTypes.property_}>{_ENTITY_ID_REGEX})\)"
 _ENTITY_PATTERN = re.compile(r"^(?P<prefix>.*?):?(?P<suffix>[^(:]*)(\((?P<content>[^)]+)\))?$")
 
 
-class _UndefinedType(BaseModel):
-    ...
+class _UndefinedType(BaseModel): ...
 
 
 class _UnknownType(BaseModel):

cognite/neat/rules/models/rdfpath.py

@@ -1,5 +1,4 @@
-"""
-"""
+""" """
 
 import re
 import sys