cognite-neat 0.100.1__py3-none-any.whl → 0.101.0__py3-none-any.whl

cognite_neat-0.100.1.dist-info/METADATA

@@ -1,215 +0,0 @@
-Metadata-Version: 2.1
-Name: cognite-neat
-Version: 0.100.1
-Summary: Knowledge graph transformation
-Home-page: https://cognite-neat.readthedocs-hosted.com/
-License: Apache-2.0
-Author: Nikola Vasiljevic
-Author-email: nikola.vasiljevic@cognite.com
-Requires-Python: >=3.10,<4.0
-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
-Provides-Extra: all
-Provides-Extra: docs
-Provides-Extra: google
-Provides-Extra: oxi
-Provides-Extra: service
-Requires-Dist: PyYAML
-Requires-Dist: backports.strenum (>=1.2,<2.0) ; python_version < "3.11"
-Requires-Dist: cognite-sdk (>=7.54.6,<8.0.0)
-Requires-Dist: elementpath (>=4.0.0,<5.0.0)
-Requires-Dist: exceptiongroup (>=1.1.3,<2.0.0) ; python_version < "3.11"
-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: jsonpath-python (>=1.0.6,<2.0.0)
-Requires-Dist: lxml (>=5.3.0,<6.0.0) ; extra == "all"
-Requires-Dist: mixpanel (>=4.10.1,<5.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"
-Requires-Dist: mkdocs-git-revision-date-localized-plugin ; extra == "docs"
-Requires-Dist: mkdocs-gitbook ; extra == "docs"
-Requires-Dist: mkdocs-glightbox ; extra == "docs"
-Requires-Dist: mkdocs-jupyter ; extra == "docs"
-Requires-Dist: mkdocs-material-extensions ; extra == "docs"
-Requires-Dist: mkdocstrings[python] ; extra == "docs"
-Requires-Dist: networkx (>=3.4.2,<4.0.0)
-Requires-Dist: openpyxl
-Requires-Dist: oxrdflib[oxigraph] (>=0.4.0,<0.5.0) ; extra == "oxi" or extra == "all"
-Requires-Dist: packaging (>=22.0,<25.0)
-Requires-Dist: pandas
-Requires-Dist: prometheus-client (>=0,<1) ; extra == "service" or extra == "all"
-Requires-Dist: pydantic (>=2,<3)
-Requires-Dist: pymdown-extensions ; extra == "docs"
-Requires-Dist: pyoxigraph (==0.4.3) ; 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)
-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"
-Requires-Dist: urllib3 (>=2,<3)
-Requires-Dist: uvicorn[standard] (>=0,<1) ; extra == "service" or extra == "all"
-Project-URL: Documentation, https://cognite-neat.readthedocs-hosted.com/
-Project-URL: Repository, https://github.com/cognitedata/neat
-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)
-[![Docker Pulls](https://img.shields.io/docker/pulls/cognite/neat?style=for-the-badge)](https://hub.docker.com/r/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)
-
-This is python package handles transformation of domain knowledge graphs (more detailed, overarching) to app specific knowledge graphs.
-Documenation available at [https://thisisneat.io](https://thisisneat.io).
-
-## Quickstart
-
-### Option 1 - Python Package
-
-`neat` can be installed as a Python package, and a docker image for more robust execution and support such
-as `graphdb` for caching. This quickstart guide uses the Python package.
-
-### Option 2 - Docker container
-
-Running NEAT as docker container :
-`docker run -p 8000:8000 --name neat cognite/neat:latest`
-
-Runnin NEAT as docker container with local data folder mounted :
-`docker run -p 8000:8000 --name neat -v $(shell pwd)/docker/vol_data:/app/data  cognite/neat:latest`
-
-### Installation (Development setup)
-
-Prerequisites:
-
-- `poetry` installed on your system, [see installation](https://python-poetry.org/docs/).
-- `npm` installed on your system, [see installation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
-- `react-scripts` installed on your system, [`npm i react-scripts`](https://www.npmjs.com/package/react-scripts)
-
-1. Clone this repo: `git clone git@github.com:cognitedata/neat.git`
-2. Create wheel: `make build-python`. This will create a wheel in the `dist` folder.
-3. Install wheel in your preferred environment, `pip install dist/neat-[NEAT_VERSTION]-py3-none-any.whl`
-
-### Run Neat (Python Package)
-
-Once installed you can run neat with the command
-
-```bash
-neat
-```
-
-This will open your browser and launch the neat application.
-
-Note this will automatically create a `data` folder in your current working directory, which is populated
-with default workflows, rule sheets, and source graphs. In addition, there is a `config.yaml` you can add
-your CDF credentials to allow `neat` access CDF.
-
-![launch_neat](https://user-images.githubusercontent.com/60234212/228812422-c5e9519f-19e7-4f08-9617-66a790323c7e.gif)
-
-## Documentation
-
-[Documentation](https://cognite-neat.readthedocs-hosted.com/en/latest/)
-
-![](./docs/figs/high-level-io.png)
-
-## Docker container build process
-
-`make build-docker`
-
-## Starting the application locally using GraphDB as external rdf store
-
-Run the command :
-
-` make compose-up`
-
-The command starts NEAT container and GraphDB container and creates _vol_data_ and _vol_shared_ local folders that are mounted as volumes.
-
-_vol_data_ - is mounted only in NEAT container. It contains `config.yaml`, `workflows`, `rules`. You can set `load_examples` to `true` to populate it with examples.
-
-_vol_shared_ - is mounted to both containers and files placed here become automatically visible for GraphDB import process. Main intension is to write files from NEAT container and make them available for GraphDB for import.
-
-## Web UI
-
-`http://localhost:8000`
-
-Open API docs :
-
-`http://localhost:8000/docs`
-
-
-## Workflows and configurations
-
-All configurations are divided into 2 categories :
-
-- global configurations - global for entire service , loaded at startup (config.yaml)
-- workflow configurations - local to workflow , loaded from workflow manifest (.yaml)
-
-## Global configurations
-
-Global configurations loaded by the application during startup process, either from ENV variables or file.
-
-The application tries to load the configuration as follows.
-
-1. Try ENV variables. This is done by checking for the ENV variable `NEAT_CDF_PROJECT`, and if it exists load the rest
-   as they are listed below.
-2. Try from file. This is done by checking the ENV variable `NEAT_CONFIG_PATH`, which defaults to `$(cwd)/config.yaml`,
-   for a path. The config file es expected to have the structure as shown below.
-3. Exit. It the ENV variable `NEAT_CDF_PROJECT` and the config file does not exist, the applications exists.
-
-### Env Variables
-
-- NEAT_CDF_PROJECT
-- NEAT_CDF_CLIENT_NAME
-- NEAT_CDF_CLIENT_ID
-- NEAT_CDF_CLIENT_SECRET
-- NEAT_CDF_BASE_URL
-- NEAT_CDF_TOKEN_URL
-- NEAT_CDF_SCOPES
-- NEAT_WORKFLOW_DOWNLOADER_FILTER - list of workflows or tags that must be loaded from CDF automatically during startup
-- NEAT_DATA_PATH - local directory for workflow and rules storage
-- NEAT_CDF_DEFAULT_DATASET_ID - default dataset id that is used for sharing workflows, rules fies and execution traces
-- NEAT_LOG_LEVEL - supported logging levels `DEBUG` , `INFO` (default)
-
-### Config file
-
-```yaml
-workflows_store_type: file
-data_store_path: /app/data
-
-cdf_client:
-  project: get-power-grid
-  client_id: "623c2450-cfc2-43d6-9036-10e14dad8ccf"
-  client_secret: "my-super-secret"
-  base_url: https://az-power-no-northeurope.cognitedata.com
-  scopes: [https://az-power-no-northeurope.cognitedata.com/.default]
-  token_url: https://login.microsoftonline.com/e55e1701-82f8-4c52-af10-28e4d942c589/oauth2/v2.0/token
-
-cdf_default_dataset_id: 2626756768281823
-workflow_downloader_filter:
-  - tag:grid
-log_level: DEBUG
-```
-
-## Automatic workflow loading from CDF during application startup
-
-If `workflow_downloader_filter` is set, the app will try to download workflows from CDF based on provided filtering conditions .
-Filtering format :
-
-- `name:<workflows_name>=<workflow_version>` - loading workflow by name and version or latest by name if version is not set.
-- `tag:<tag_name>`- loading all workflows that tagged with specific tag.
-