cognite-neat 0.123.26__py3-none-any.whl → 1.0.22__py3-none-any.whl

cognite/neat/{session → _v0/session}/_fix.py

@@ -1,7 +1,7 @@
-from cognite.neat.core._data_model.transformers import (
+from cognite.neat._v0.core._data_model.transformers import (
     ToCompliantEntities,
 )
-from cognite.neat.core._issues._base import IssueList
+from cognite.neat._v0.core._issues._base import IssueList
 
 from ._state import SessionState
 from .exceptions import session_class_wrapper

cognite/neat/{session → _v0/session}/_inspect.py

@@ -4,9 +4,9 @@ from typing import Literal, overload
 
 import pandas as pd
 
-from cognite.neat.core._constants import IN_NOTEBOOK
-from cognite.neat.core._issues import IssueList
-from cognite.neat.core._utils.upload import (
+from cognite.neat._v0.core._constants import IN_NOTEBOOK
+from cognite.neat._v0.core._issues import IssueList
+from cognite.neat._v0.core._utils.upload import (
     UploadResult,
     UploadResultCore,
     UploadResultList,

cognite/neat/{session → _v0/session}/_mapping.py

@@ -1,12 +1,12 @@
-from cognite.neat.core._data_model.models.mapping import load_classic_to_core_mapping
-from cognite.neat.core._data_model.transformers import (
+from cognite.neat._v0.core._data_model.models.mapping import load_classic_to_core_mapping
+from cognite.neat._v0.core._data_model.transformers import (
     AsParentPropertyId,
     ChangeViewPrefix,
     IncludeReferenced,
     PhysicalDataModelMapper,
     VerifiedDataModelTransformer,
 )
-from cognite.neat.core._issues import IssueList
+from cognite.neat._v0.core._issues import IssueList
 
 from ._state import SessionState
 from .exceptions import NeatSessionError, session_class_wrapper

cognite/neat/{session → _v0/session}/_plugin.py

@@ -2,11 +2,10 @@ import warnings
 from pathlib import Path
 from typing import Any
 
-from cognite.neat.core._issues._base import IssueList
-from cognite.neat.core._utils.reader._base import NeatReader
-from cognite.neat.plugins import get_plugin_manager
-from cognite.neat.plugins.data_model.importers._base import DataModelImporterPlugin
-from cognite.neat.session._experimental import ExperimentalFlags
+from cognite.neat._v0.core._issues._base import IssueList
+from cognite.neat._v0.core._utils.reader._base import NeatReader
+from cognite.neat._v0.plugins import DataModelImporterPlugin, get_plugin_manager
+from cognite.neat._v0.session._experimental import ExperimentalFlags
 
 from ._state import SessionState
 from .exceptions import session_class_wrapper

cognite/neat/{session → _v0/session}/_prepare.py

@@ -4,19 +4,19 @@ from typing import Any
 
 from rdflib import URIRef
 
-from cognite.neat.core._data_model.transformers import PrefixEntities, StandardizeNaming
-from cognite.neat.core._data_model.transformers._converters import StandardizeSpaceAndVersion
-from cognite.neat.core._instances.transformers import (
+from cognite.neat._v0.core._data_model.transformers import PrefixEntities, StandardizeNaming
+from cognite.neat._v0.core._data_model.transformers._converters import StandardizeSpaceAndVersion
+from cognite.neat._v0.core._instances.transformers import (
     ConnectionToLiteral,
     ConvertLiteral,
     LiteralToEntity,
     RelationshipAsEdgeTransformer,
 )
-from cognite.neat.core._instances.transformers._rdfpath import MakeConnectionOnExactMatch
-from cognite.neat.core._issues import IssueList
-from cognite.neat.core._issues.errors import NeatValueError
-from cognite.neat.core._utils.text import humanize_collection
-from cognite.neat.session._experimental import ExperimentalFlags
+from cognite.neat._v0.core._instances.transformers._rdfpath import MakeConnectionOnExactMatch
+from cognite.neat._v0.core._issues import IssueList
+from cognite.neat._v0.core._issues.errors import NeatValueError
+from cognite.neat._v0.core._utils.text import humanize_collection
+from cognite.neat._v0.session._experimental import ExperimentalFlags
 
 from ._state import SessionState
 from .exceptions import NeatSessionError, session_class_wrapper

cognite/neat/{session → _v0/session}/_read.py

@@ -1,45 +1,49 @@
+import re
 import warnings
 from typing import Any, Literal, cast
 
 from cognite.client.data_classes.data_modeling import DataModelId, DataModelIdentifier
 from cognite.client.utils.useful_types import SequenceNotStr
+from rdflib import URIRef
 
-from cognite.neat.core._client import NeatClient
-from cognite.neat.core._constants import (
+from cognite.neat._v0.core._client import NeatClient
+from cognite.neat._v0.core._constants import (
     CLASSIC_CDF_NAMESPACE,
+    NAMED_GRAPH_NAMESPACE,
     get_default_prefixes_and_namespaces,
 )
-from cognite.neat.core._data_model import catalog, importers
-from cognite.neat.core._data_model.importers import BaseImporter
-from cognite.neat.core._data_model.models.entities._single_value import ViewEntity
-from cognite.neat.core._data_model.transformers import ClassicPrepareCore
-from cognite.neat.core._data_model.transformers._converters import (
+from cognite.neat._v0.core._data_model import catalog, importers
+from cognite.neat._v0.core._data_model._constants import SPACE_COMPLIANCE_REGEX
+from cognite.neat._v0.core._data_model.importers import BaseImporter
+from cognite.neat._v0.core._data_model.models.entities._single_value import ViewEntity
+from cognite.neat._v0.core._data_model.transformers import ClassicPrepareCore
+from cognite.neat._v0.core._data_model.transformers._converters import (
     ToEnterpriseModel,
     _SubsetEditableCDMPhysicalDataModel,
 )
-from cognite.neat.core._instances import examples as instances_examples
-from cognite.neat.core._instances import extractors
-from cognite.neat.core._instances.extractors._classic_cdf._base import InstanceIdPrefix
-from cognite.neat.core._instances.transformers import (
+from cognite.neat._v0.core._instances import examples as instances_examples
+from cognite.neat._v0.core._instances import extractors
+from cognite.neat._v0.core._instances.extractors._classic_cdf._base import InstanceIdPrefix
+from cognite.neat._v0.core._instances.transformers import (
     ConvertLiteral,
     LiteralToEntity,
     Transformers,
 )
-from cognite.neat.core._instances.transformers._prune_graph import (
+from cognite.neat._v0.core._instances.transformers._prune_graph import (
     AttachPropertyFromTargetToSource,
     PruneDeadEndEdges,
     PruneInstancesOfUnknownType,
     PruneTypes,
 )
-from cognite.neat.core._issues import IssueList
-from cognite.neat.core._issues.errors import NeatValueError
-from cognite.neat.core._issues.warnings import MissingCogniteClientWarning
-from cognite.neat.core._utils.reader import NeatReader
-from cognite.neat.session._experimental import ExperimentalFlags
+from cognite.neat._v0.core._issues import IssueList
+from cognite.neat._v0.core._issues.errors import NeatValueError
+from cognite.neat._v0.core._issues.warnings import MissingCogniteClientWarning
+from cognite.neat._v0.core._utils.reader import NeatReader
+from cognite.neat._v0.engine import import_engine
+from cognite.neat._v0.session._experimental import ExperimentalFlags
 
 from ._state import SessionState
 from ._wizard import NeatObjectType, RDFFileType, XMLFileType, object_wizard, rdf_dm_wizard, xml_format_wizard
-from .engine import import_engine
 from .exceptions import NeatSessionError, session_class_wrapper
 
 
@@ -826,13 +830,21 @@ class RDFReadAPI(BaseReadAPI):
         importer = importers.OWLImporter.from_file(reader.materialize_path(), source_name=f"file {reader!s}")
         return self._state.data_model_import(importer)
 
-    def instances(self, io: Any) -> IssueList:
+    def instances(self, io: Any, named_graph: str | None = None) -> IssueList:
         self._state._raise_exception_if_condition_not_met(
             "Read RDF Instances",
             empty_data_model_store_required=True,
         )
         reader = NeatReader.create(io)
-        self._state.instances.store.write(extractors.RdfFileExtractor(reader.materialize_path()))
+
+        # validate and convert named_graph to URI
+        named_graph_uri: URIRef | None = None
+        if named_graph:
+            if not re.match(SPACE_COMPLIANCE_REGEX, named_graph):
+                raise NeatValueError(f"Named graph '{named_graph}' does not comply with naming requirements. ")
+            named_graph_uri = NAMED_GRAPH_NAMESPACE[named_graph]
+
+        self._state.instances.store.write(extractors.RdfFileExtractor(reader.materialize_path()), named_graph_uri)
         return IssueList()
 
     def __call__(
@@ -840,6 +852,7 @@ class RDFReadAPI(BaseReadAPI):
         io: Any,
         type: NeatObjectType | None = None,
         source: RDFFileType | None = None,
+        named_graph: str | URIRef | None = None,
     ) -> IssueList:
         if type is None:
             type = object_wizard()
@@ -858,7 +871,7 @@ class RDFReadAPI(BaseReadAPI):
                 raise ValueError(f"Expected ontology, imf types or instances, got {source}")
 
         elif type == "instances":
-            return self.instances(io)
+            return self.instances(io, named_graph=named_graph)
 
         else:
             raise NeatSessionError(f"Expected data model or instances, got {type}")

cognite/neat/{session → _v0/session}/_set.py

@@ -1,14 +1,14 @@
 from cognite.client import CogniteClient
 from cognite.client import data_modeling as dm
 
-from cognite.neat.core._client import NeatClient
-from cognite.neat.core._constants import COGNITE_MODELS
-from cognite.neat.core._data_model.models import PhysicalDataModel
-from cognite.neat.core._data_model.transformers import SetIDDMSModel
-from cognite.neat.core._instances.transformers import SetType
-from cognite.neat.core._issues import IssueList
-from cognite.neat.core._issues.errors import NeatValueError
-from cognite.neat.core._utils.text import humanize_collection
+from cognite.neat._v0.core._client import NeatClient
+from cognite.neat._v0.core._constants import COGNITE_MODELS
+from cognite.neat._v0.core._data_model.models import PhysicalDataModel
+from cognite.neat._v0.core._data_model.transformers import SetIDDMSModel
+from cognite.neat._v0.core._instances.transformers import SetType
+from cognite.neat._v0.core._issues import IssueList
+from cognite.neat._v0.core._issues.errors import NeatValueError
+from cognite.neat._v0.core._utils.text import humanize_collection
 
 from ._state import SessionState
 from .exceptions import NeatSessionError, session_class_wrapper

cognite/neat/{session → _v0/session}/_show.py

@@ -6,11 +6,11 @@ import networkx as nx
 from IPython.display import HTML, display
 from pyvis.network import Network as PyVisNetwork  # type: ignore
 
-from cognite.neat.core._constants import IN_NOTEBOOK, IN_PYODIDE
-from cognite.neat.core._data_model.analysis._base import DataModelAnalysis
-from cognite.neat.core._utils.io_ import to_directory_compatible
-from cognite.neat.core._utils.rdf_ import remove_namespace_from_uri, uri_display_name
-from cognite.neat.session.exceptions import NeatSessionError
+from cognite.neat._v0.core._constants import IN_NOTEBOOK, IN_PYODIDE
+from cognite.neat._v0.core._data_model.analysis._base import DataModelAnalysis
+from cognite.neat._v0.core._utils.io_ import to_directory_compatible
+from cognite.neat._v0.core._utils.rdf_ import remove_namespace_from_uri, uri_display_name
+from cognite.neat._v0.session.exceptions import NeatSessionError
 
 from ._state import SessionState
 from .exceptions import session_class_wrapper

cognite/neat/{session → _v0/session}/_state.py

@@ -3,18 +3,18 @@ from typing import Literal, cast
 
 from rdflib import URIRef
 
-from cognite.neat.core._client import NeatClient
-from cognite.neat.core._data_model.importers import BaseImporter, InferenceImporter
-from cognite.neat.core._data_model.models import ConceptualDataModel, PhysicalDataModel
-from cognite.neat.core._data_model.models.conceptual._validation import ConceptualValidation
-from cognite.neat.core._data_model.transformers import (
+from cognite.neat._v0.core._client import NeatClient
+from cognite.neat._v0.core._data_model.importers import BaseImporter, InferenceImporter
+from cognite.neat._v0.core._data_model.models import ConceptualDataModel, PhysicalDataModel
+from cognite.neat._v0.core._data_model.models.conceptual._validation import ConceptualValidation
+from cognite.neat._v0.core._data_model.transformers import (
     VerifiedDataModelTransformer,
 )
-from cognite.neat.core._instances.extractors import KnowledgeGraphExtractor
-from cognite.neat.core._issues import IssueList
-from cognite.neat.core._issues.warnings._models import ConversionToPhysicalModelImpossibleWarning
-from cognite.neat.core._store import NeatDataModelStore, NeatInstanceStore
-from cognite.neat.core._utils.upload import UploadResultList
+from cognite.neat._v0.core._instances.extractors import KnowledgeGraphExtractor
+from cognite.neat._v0.core._issues import IssueList
+from cognite.neat._v0.core._issues.warnings._models import ConversionToPhysicalModelImpossibleWarning
+from cognite.neat._v0.core._store import NeatDataModelStore, NeatInstanceStore
+from cognite.neat._v0.core._utils.upload import UploadResultList
 
 from .exceptions import NeatSessionError, _session_method_wrapper
 

cognite/neat/{session → _v0/session}/_subset.py

@@ -1,15 +1,15 @@
 import warnings
 
-from cognite.neat.core._data_model.models.entities._single_value import (
+from cognite.neat._v0.core._data_model.models.entities._single_value import (
     ConceptEntity,
     ViewEntity,
 )
-from cognite.neat.core._data_model.transformers import (
+from cognite.neat._v0.core._data_model.transformers import (
     SubsetConceptualDataModel,
     SubsetPhysicalDataModel,
 )
-from cognite.neat.core._issues._base import IssueList
-from cognite.neat.session._experimental import ExperimentalFlags
+from cognite.neat._v0.core._issues._base import IssueList
+from cognite.neat._v0.session._experimental import ExperimentalFlags
 
 from ._state import SessionState
 from .exceptions import NeatSessionError, session_class_wrapper

cognite/neat/{session → _v0/session}/_template.py

@@ -3,23 +3,23 @@ from typing import Any, Literal
 
 from cognite.client.data_classes.data_modeling import DataModelIdentifier
 
-from cognite.neat.core._constants import BASE_MODEL
-from cognite.neat.core._data_model._shared import ImportedDataModel
-from cognite.neat.core._data_model.exporters import ExcelExporter
-from cognite.neat.core._data_model.importers import ExcelImporter
-from cognite.neat.core._data_model.models import UnverifiedConceptualDataModel
-from cognite.neat.core._data_model.models._base_verified import RoleTypes
-from cognite.neat.core._data_model.models.physical import PhysicalValidation
-from cognite.neat.core._data_model.transformers import (
+from cognite.neat._v0.core._constants import BASE_MODEL
+from cognite.neat._v0.core._data_model._shared import ImportedDataModel
+from cognite.neat._v0.core._data_model.exporters import ExcelExporter
+from cognite.neat._v0.core._data_model.importers import ExcelImporter
+from cognite.neat._v0.core._data_model.models import UnverifiedConceptualDataModel
+from cognite.neat._v0.core._data_model.models._base_verified import RoleTypes
+from cognite.neat._v0.core._data_model.models.physical import PhysicalValidation
+from cognite.neat._v0.core._data_model.transformers import (
     AddCogniteProperties,
     IncludeReferenced,
     ToDataProductModel,
     ToEnterpriseModel,
     VerifiedDataModelTransformer,
 )
-from cognite.neat.core._issues import IssueList, catch_issues
-from cognite.neat.core._utils.reader import NeatReader, PathReader
-from cognite.neat.session._experimental import ExperimentalFlags
+from cognite.neat._v0.core._issues import IssueList, catch_issues
+from cognite.neat._v0.core._utils.reader import NeatReader, PathReader
+from cognite.neat._v0.session._experimental import ExperimentalFlags
 
 from ._state import SessionState
 from .exceptions import NeatSessionError, session_class_wrapper

cognite/neat/{session → _v0/session}/_to.py

@@ -6,18 +6,18 @@ from typing import Any, Literal, cast, overload
 from cognite.client import data_modeling as dm
 from cognite.client.data_classes.data_modeling import DataModelIdentifier
 
-from cognite.neat.core._client._api_client import NeatClient
-from cognite.neat.core._constants import COGNITE_MODELS
-from cognite.neat.core._data_model import exporters
-from cognite.neat.core._data_model._constants import PATTERNS
-from cognite.neat.core._data_model._shared import VerifiedDataModel
-from cognite.neat.core._data_model.importers import DMSImporter
-from cognite.neat.core._data_model.models import ConceptualDataModel, PhysicalDataModel
-from cognite.neat.core._data_model.models.physical import PhysicalMetadata
-from cognite.neat.core._instances import loaders
-from cognite.neat.core._issues import IssueList, NeatIssue, catch_issues
-from cognite.neat.core._utils.upload import UploadResultList
-from cognite.neat.session._experimental import ExperimentalFlags
+from cognite.neat._v0.core._client._api_client import NeatClient
+from cognite.neat._v0.core._constants import COGNITE_MODELS
+from cognite.neat._v0.core._data_model import exporters
+from cognite.neat._v0.core._data_model._constants import PATTERNS
+from cognite.neat._v0.core._data_model._shared import VerifiedDataModel
+from cognite.neat._v0.core._data_model.importers import DMSImporter
+from cognite.neat._v0.core._data_model.models import ConceptualDataModel, PhysicalDataModel
+from cognite.neat._v0.core._data_model.models.physical import PhysicalMetadata
+from cognite.neat._v0.core._instances import loaders
+from cognite.neat._v0.core._issues import IssueList, NeatIssue, catch_issues
+from cognite.neat._v0.core._utils.upload import UploadResultList
+from cognite.neat._v0.session._experimental import ExperimentalFlags
 
 from ._state import SessionState
 from .exceptions import NeatSessionError, session_class_wrapper

cognite/neat/{session → _v0/session}/_wizard.py

@@ -3,7 +3,7 @@ from typing import Literal, TypeVar, get_args
 
 from rich.prompt import IntPrompt, Prompt
 
-from cognite.neat.core._data_model._constants import PATTERNS
+from cognite.neat._v0.core._data_model._constants import PATTERNS
 
 RDFFileType = Literal["Ontology", "IMF Types", "Inference"]
 NeatObjectType = Literal["Data Model", "Instances"]

cognite/neat/{session → _v0/session}/exceptions.py

@@ -3,11 +3,11 @@ import warnings
 from collections.abc import Callable
 from typing import Any, TypeVar
 
-from cognite.neat.core._issues.errors import CDFMissingClientError, NeatImportError
-from cognite.neat.core._issues.errors._external import OxigraphStorageLockedError
-from cognite.neat.core._issues.errors._general import NeatValueError, WillExceedLimitError
-from cognite.neat.plugins._issues import PluginError
-from cognite.neat.session._experimental import ExperimentalFeatureWarning
+from cognite.neat._v0.core._issues.errors import CDFMissingClientError, NeatImportError
+from cognite.neat._v0.core._issues.errors._external import OxigraphStorageLockedError
+from cognite.neat._v0.core._issues.errors._general import NeatValueError, WillExceedLimitError
+from cognite.neat._v0.plugins._issues import PluginError
+from cognite.neat._v0.session._experimental import ExperimentalFeatureWarning
 
 from ._collector import _COLLECTOR
 

cognite/neat/_version.py

@@ -1,2 +1,2 @@
-__version__ = "0.123.26"
+__version__ = "1.0.22"
 __engine__ = "^2.0.4"

cognite/neat/legacy.py

@@ -0,0 +1,6 @@
+from cognite.neat._v0.core._utils.auth import get_cognite_client
+from cognite.neat._v0.session._base import NeatSession
+
+from ._version import __version__
+
+__all__ = ["NeatSession", "__version__", "get_cognite_client"]

cognite_neat-1.0.22.dist-info/METADATA

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: cognite-neat
+Version: 1.0.22
+Summary: Knowledge graph transformation
+Author: Nikola Vasiljevic, Anders Albert
+Author-email: Nikola Vasiljevic <nikola.vasiljevic@cognite.com>, Anders Albert <anders.albert@cognite.com>
+License-Expression: Apache-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Customer Service
+Classifier: Topic :: Database
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Dist: pandas>=1.5.3,<3.0.0
+Requires-Dist: cognite-sdk>=7.83.0,<8.0.0
+Requires-Dist: rdflib>=7.0.0,<8.0.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.0.0,<3.0.0
+Requires-Dist: pyyaml>=6.0.1,<7.0.0
+Requires-Dist: requests>=2.28.1,<3.0.0
+Requires-Dist: urllib3>=1.26.15,<3.0.0
+Requires-Dist: openpyxl>=3.0.10,<4.0.0
+Requires-Dist: networkx>=3.4.2,<4.0.0
+Requires-Dist: mixpanel>=4.10.1,<5.0.0
+Requires-Dist: packaging>=22.0
+Requires-Dist: jsonpath-python>=1.0.6,<2.0.0
+Requires-Dist: elementpath>=4.0.0,<5.0.0
+Requires-Dist: pyvis>=0.3.2,<1.0.0
+Requires-Dist: rich[jupyter]>=13.7.1,<14.0.0
+Requires-Dist: exceptiongroup>=1.1.3,<2.0.0 ; python_full_version < '3.11'
+Requires-Dist: backports-strenum>=1.2,<2.0.0 ; python_full_version < '3.11'
+Requires-Dist: typing-extensions>=4.8.0,<5.0.0 ; python_full_version < '3.11'
+Requires-Dist: tomli>=2.0.1,<3.0.0 ; python_full_version < '3.11'
+Requires-Dist: mkdocs>=1.4.0,<2.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-jupyter>=0.25.1,<1.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-material-extensions>=1.3.1,<2.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-git-revision-date-localized-plugin ; extra == 'docs'
+Requires-Dist: mkdocs-git-authors-plugin>=0.9.4,<1.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-gitbook>=0.0.1,<1.0.0 ; extra == 'docs'
+Requires-Dist: mkdocs-glightbox>=0.4.0,<1.0.0 ; extra == 'docs'
+Requires-Dist: pymdown-extensions>=10.14.3,<11.0.0 ; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.25.2,<1.0.0 ; extra == 'docs'
+Requires-Dist: mistune==3.0.2 ; extra == 'docs'
+Requires-Dist: mkdocs-autorefs>=0.5.0,<1.0.0 ; extra == 'docs'
+Requires-Dist: gspread>=5.0.0,<6.0.0 ; extra == 'google'
+Requires-Dist: google-api-python-client>=2.70.0,<3.0.0 ; extra == 'google'
+Requires-Dist: google-auth-oauthlib>=1.0.0,<2.0.0 ; extra == 'google'
+Requires-Dist: lxml>=5.3.0,<6.0.0 ; extra == 'lxml'
+Requires-Dist: oxrdflib>=0.4.0,<0.5.0 ; extra == 'oxi'
+Requires-Dist: pyoxigraph>=0.4.3,<0.5.0 ; extra == 'oxi'
+Requires-Python: >=3.10
+Project-URL: Changelog, https://github.com/cognitedata/neat/releases
+Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
+Project-URL: GitHub, https://github.com/cognitedata/neat
+Project-URL: Homepage, https://cognite-neat.readthedocs-hosted.com/
+Provides-Extra: docs
+Provides-Extra: google
+Provides-Extra: lxml
+Provides-Extra: oxi
+Description-Content-Type: text/markdown
+
+# kNowlEdge grAph Transformer (NEAT)
+
+[![release](https://img.shields.io/github/actions/workflow/status/cognitedata/neat/release.yaml?style=for-the-badge)](https://github.com/cognitedata/neat/actions/workflows/release.yaml)
+[![Documentation Status](https://readthedocs.com/projects/cognite-neat/badge/?version=latest&style=for-the-badge)](https://cognite-neat.readthedocs-hosted.com/en/latest/?badge=latest)
+[![Github](https://shields.io/badge/github-cognite/neat-green?logo=github&style=for-the-badge)](https://github.com/cognitedata/neat)
+[![PyPI](https://img.shields.io/pypi/v/cognite-neat?style=for-the-badge)](https://pypi.org/project/cognite-neat/)
+[![Downloads](https://img.shields.io/pypi/dm/cognite-neat?style=for-the-badge)](https://pypistats.org/packages/cognite-neat)
+[![GitHub](https://img.shields.io/github/license/cognitedata/neat?style=for-the-badge)](https://github.com/cognitedata/neat/blob/master/LICENSE)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/ambv/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=for-the-badge)](https://github.com/astral-sh/ruff)
+[![mypy](https://img.shields.io/badge/mypy-checked-000000.svg?style=for-the-badge&color=blue)](http://mypy-lang.org)
+
+
+
+There was no easy way to make knowledge graphs, especially data models, and onboard them to
+[Cognite Data Fusion](https://www.cognite.com/en/product/cognite_data_fusion_industrial_dataops_platform), so we have built NEAT!
+
+
+NEAT is great for data model development, validation and deployment. It comes with an evergrowing library of validators,
+which will assure that your data model adheres to the best practices and that is performant. Unlike other solutions,
+which require you to be a technical wizard or modeling expert, NEAT provides you a guiding data modeling experience.
+
+We offer various interfaces on how you can develop your data model, where majority of our users prefer
+a combination of Jupyter Notebooks, leveraging NEAT features through so called [NeatSession](https://cognite-neat.readthedocs-hosted.com/en/latest/reference/NeatSession/session.html),  with [a Spreadsheet data model template](https://cognite-neat.readthedocs-hosted.com/en/latest/excel_data_modeling/data_model.html).
+
+
+Only Data modeling? There was more before!?
+True, NEAT v0.x (legacy) offered a complete knowledge graph
+tooling. Do not worry though, all the legacy features are still available and will be gradually
+ported to NEAT v1.x according to the [roadmap](https://cognite-neat.readthedocs-hosted.com/en/latest/roadmap.html).
+
+
+## Usage
+The user interface for `NEAT` features is through `NeatSession`, which is typically instantiated in a notebook-based environment due to simplified interactivity with `NEAT`
+and navigation of the session content. Once you have set up your notebook environment, and installed neat via:
+
+```bash
+pip install cognite-neat
+```
+
+you start by creating a `CogniteClient` and instantiate a `NeatSession` object:
+
+```python
+from cognite.neat import NeatSession, get_cognite_client
+
+client = get_cognite_client(".env")
+
+neat = NeatSession(client)
+
+neat.physical_data_model.read.cdf("cdf_cdm", "CogniteCore", "v1")
+```
+
+## Documentation
+
+
+For more information, see the [documentation](https://cognite-neat.readthedocs-hosted.com/en/latest/)