Skip to main content

Library to connect to TigerGraph databases

Project description

pyTigerGraph

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

Getting Started

To download pyTigerGraph, simply run: pip3 install pyTigerGraph Once the package installs, you can import it and instantiate a connection to your database:

import pyTigerGraph as tg

conn = tg.TigerGraphConnection(host="<hostname>", graphname="<graph_name>", username="<username>", password="<password>", apiToken="<api_token>")

If your database is not using the standard ports (or they are mapped), you can use the following arguments to specify those:

For example, in case of using a local virtual machine with the ports mapped:

conn = tg.TigerGraphConnection(host="localhost", restppPort=25900, gsPort=25240, graphname="MyGraph", username="tigergraph", password="tigergraph", apiToken="2aa016d747ede9gg6da3drslm98srfoj")

For more details on establishing a connection, read the Getting Started page.

Development

Fork or clone this repo. Check out a new branch.

Set up the dev environment:

  • For core functions
  • For the GDS subpackage, install the gds_dev_env.yml environment in the "conda" folder. If you don't have conda, install miniforge first. (Don't use miniconda as Anaconda repo has a restrictive license now.)

Work on your branch. Once your work is done, send a pull request. Unit tests are required for the review.

Example Projects

Credits

pyTigerGraph was originally created by Parker Erickson, a Computer Science student at the University of Minnesota. Special thanks to contributors Jon Herke and Szilard Barany of TigerGraph. Read this to learn more about how you can contribute.

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

pyTigerGraphBeta-0.0.9.9.2.tar.gz (100.4 kB view details)

Uploaded Source

Built Distribution

pyTigerGraphBeta-0.0.9.9.2-py3-none-any.whl (129.8 kB view details)

Uploaded Python 3

File details

Details for the file pyTigerGraphBeta-0.0.9.9.2.tar.gz.

File metadata

  • Download URL: pyTigerGraphBeta-0.0.9.9.2.tar.gz
  • Upload date:
  • Size: 100.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for pyTigerGraphBeta-0.0.9.9.2.tar.gz
Algorithm Hash digest
SHA256 4d5eb9539bbc244643b065fbe1329e857d20fc7ab4789f206e7c7ab613d6bab1
MD5 8230e02fc5fba879528bc2a02a7f0d4d
BLAKE2b-256 0707f5f7e026893d9382cd7f419f14ebcf45c05449096c037abf1ed929fbb69f

See more details on using hashes here.

File details

Details for the file pyTigerGraphBeta-0.0.9.9.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pyTigerGraphBeta-0.0.9.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b8416de5b8a25c33e251d98c012cfea86fdfdfe792f3dc05f8b1e80ae4bbd4e5
MD5 8bf7bf27b65b0b05c7a561466f4e5ccc
BLAKE2b-256 bf208f14288749072e2a53a427eed606e39047c952ed2b7fc91db7688817218c

See more details on using hashes here.

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