Skip to main content

A Python library and set of command line utilities for exchanging Knowledge Graphs (KGs) that conform to or are aligned to the Biolink Model.

Project description

Knowledge Graph Exchange

Python Run testsDocumentation Status Quality Gate Status Maintainability Rating Coverage PyPI Docker

KGX (Knowledge Graph Exchange) is a Python library and set of command line utilities for exchanging Knowledge Graphs (KGs) that conform to or are aligned to the Biolink Model.

The core datamodel is a Property Graph (PG), represented internally in Python using a networkx MultiDiGraph model.

KGX allows conversion to and from:

KGX will also provide validation, to ensure the KGs are conformant to the Biolink Model: making sure nodes are categorized using Biolink classes, edges are labeled using valid Biolink relationship types, and valid properties are used.

Internal representation is a property graph, specifically a networkx MultiDiGraph.

The structure of this graph is expected to conform to the Biolink Model standard, as specified in the KGX format specification.

In addition to the main code-base, KGX also provides a series of command line operations.

Installation

The installation for KGX requires Python 3.7 or greater.

Installation for users

Installing from PyPI

KGX is available on PyPI and can be installed using pip as follows,

pip install kgx

To install a particular version of KGX, be sure to specify the version number,

pip install kgx==0.5.0

Installing from GitHub

Clone the GitHub repository and then install,

git clone https://github.com/biolink/kgx
cd kgx
python setup.py install

Installation for developers

Setting up a development environment

To build directly from source, first clone the GitHub repository,

git clone https://github.com/biolink/kgx
cd kgx

Then install the necessary dependencies listed in requirements.txt,

pip3 install -r requirements.txt

For convenience, make use of the venv module in Python3 to create a lightweight virtual environment,

python3 -m venv env
source env/bin/activate

pip install -r requirements.txt

To install KGX you can do one of the following,

pip install .

# OR 

python setup.py install

Setting up a testing environment

KGX has a suite of tests that rely on Docker containers to run Neo4j specific tests.

To set up the required containers, first install Docker on your local machine.

Once Docker is up and running, run the following commands:

docker run -d --name kgx-neo4j-integration-test
            -p 7474:7474 -p 7687:7687
            --env NEO4J_AUTH=neo4j/test
            neo4j:3.5.25
docker run -d --name kgx-neo4j-unit-test
            -p 8484:7474 -p 8888:7687
            --env NEO4J_AUTH=neo4j/test
            neo4j:3.5.25

Note: Setting up the Neo4j container is optional. If there is no container set up then the tests that rely on them are skipped.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kgx-1.0.0a0.tar.gz (68.1 kB view details)

Uploaded Source

Built Distributions

kgx-1.0.0a0-py3.8.egg (130.4 kB view details)

Uploaded Source

kgx-1.0.0a0-py3-none-any.whl (133.9 kB view details)

Uploaded Python 3

File details

Details for the file kgx-1.0.0a0.tar.gz.

File metadata

  • Download URL: kgx-1.0.0a0.tar.gz
  • Upload date:
  • Size: 68.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.1

File hashes

Hashes for kgx-1.0.0a0.tar.gz
Algorithm Hash digest
SHA256 053f54c8885a2d05178d692ddc4e1c9dbd1976455cdaa1823d3aae460975dcfc
MD5 bf8d8d6cde1a788824b1ad0f99ca8712
BLAKE2b-256 0473e12a9b63b470838a631006db44983e124935b6cc9914e9abb1fc84cfd3b8

See more details on using hashes here.

Provenance

File details

Details for the file kgx-1.0.0a0-py3.8.egg.

File metadata

  • Download URL: kgx-1.0.0a0-py3.8.egg
  • Upload date:
  • Size: 130.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.1

File hashes

Hashes for kgx-1.0.0a0-py3.8.egg
Algorithm Hash digest
SHA256 0c7044fefb222c57cd1006289d424ce11bd57aceb071b379b96cb9e1783af220
MD5 4c20338b2082cb81f3a02bcf1447863e
BLAKE2b-256 cc949d276b36682d4785b5b0d92fa5afe33fd70340f6dc534c391006a083374b

See more details on using hashes here.

Provenance

File details

Details for the file kgx-1.0.0a0-py3-none-any.whl.

File metadata

  • Download URL: kgx-1.0.0a0-py3-none-any.whl
  • Upload date:
  • Size: 133.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.1

File hashes

Hashes for kgx-1.0.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 f680900ae18ff9c37a82211020a8e13af15bb39fe5daab4e78dd741e2d744017
MD5 b6dfaf396b757c65c4985b3d55ca444a
BLAKE2b-256 d271d69cc8eb37fbd9de7c51982acce89afe0e4b85e905cf784722a292c60f60

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page