README.md

pyTigerGraph

pyTigerGraph is a Python package for connecting to TigerGraph databases. Check out the documentation here.

Quickstart

Installing pyTigerGraph

This section walks you through installing pyTigerGraph on your machine.

Prerequisites

• Python 3+
• If you wish to use the GDS functionality, install torch ahead of time.

Install pyTigerGraph

To download pyTigerGraph, run the following command in the command line or use the appropriate tool of your development environment (anaconda, PyCharm, etc.).:

pip3 install pyTigerGraph

Install pyTigerGraph[gds]

To utilize the Graph Data Science Functionality, there are a few options:

• To use the GDS functions with PyTorch Geometric, install torch and PyTorch Geometric according to their instructions:

  1. Install Torch

  2. Install PyTorch Geometric

  3. Install pyTigerGraph with:

     pip3 install 'pyTigerGraph[gds]'

• To use the GDS functions with DGL, install torch and dgl according to their instructions:

  1. Install Torch

  2. Install DGL

  3. Install pyTigerGraph with:

     pip3 install 'pyTigerGraph[gds]'

• To use the GDS functions without needing to produce output in the format supported by PyTorch Geometric or DGL. This makes the data loaders output Pandas dataframes:

pip3 install 'pyTigerGraph[gds]'

Once the package is installed, you can import it like any other Python package:

import pyTigerGraph as tg

Getting Started with Core Functions

The video above is a good starting place for learning the core functions of pyTigerGraph. This Google Colab notebook is the companion notebook to the video.