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.5.3.tar.gz (88.9 kB view details)

Uploaded Source

Built Distributions

kgx-1.5.3-py3.7.egg (109.6 kB view details)

Uploaded Source

kgx-1.5.3-py3-none-any.whl (112.5 kB view details)

Uploaded Python 3

File details

Details for the file kgx-1.5.3.tar.gz.

File metadata

  • Download URL: kgx-1.5.3.tar.gz
  • Upload date:
  • Size: 88.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.4

File hashes

Hashes for kgx-1.5.3.tar.gz
Algorithm Hash digest
SHA256 6ef5529274f38e4786c6ed2dea3b9bdd1362a23f7e644feb97d2a711d38b4bcd
MD5 6fcbd84894042e4fecf3094fbe24394c
BLAKE2b-256 893195bf16274126468d670ad6d7ee391503f65d118782d74fc94571d918832a

See more details on using hashes here.

Provenance

File details

Details for the file kgx-1.5.3-py3.7.egg.

File metadata

  • Download URL: kgx-1.5.3-py3.7.egg
  • Upload date:
  • Size: 109.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.4

File hashes

Hashes for kgx-1.5.3-py3.7.egg
Algorithm Hash digest
SHA256 4310bbdcd50cfa9ab3148bd4995cc5225b1dddabc44588f73817b31a544b277e
MD5 418c7aedf2e3a765106dfff470d15954
BLAKE2b-256 22607e2f6192ac7c8105348d7e5d62e6f84e71661b683210dfe46fdcf1a43c51

See more details on using hashes here.

Provenance

File details

Details for the file kgx-1.5.3-py3-none-any.whl.

File metadata

  • Download URL: kgx-1.5.3-py3-none-any.whl
  • Upload date:
  • Size: 112.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.4

File hashes

Hashes for kgx-1.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bba906946b45cdb2e5b13653a9244c59bf85efde47061fab8e4c66c74f5ae2fa
MD5 9e87637163359389161c5f3b53ef100b
BLAKE2b-256 08047a2af44b8e685706f315dcc4cf75dd85e1528de216a84a06788e003fe3cd

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