Skip to main content

GSQL client for TigerGraph

Project description

pyTigerDriver

Installation

install with pip:

pip install pyTigerDriver

Usage

Architecture: You can instatiate any Interface [GSQL or REST] in the pyTigerDriver seperately.

This flowchart illustrates the Classes:

graph LR
A[pyTigerDriver as tgCl] -- Gsql --> B((Gsql_Client))
A -- Rest --> C((Rest_Client))
B --> D{TigerGraph Database}
C --> D

Sample Code :

import pyTigerDriver as tg

tgCl = tg.Client(server_ip="127.0.0.1",username="tigergraph",password="tigergraph",version="3.0.5")

print("======================== SIMPLE RESTPP Queries ==================================")
print(tgCl.Rest.get("/echo")) # tgCl.Rest.post or tgCl.Rest.delete 
print("============================== SIMPLE LS ===========================================")
print(tgCl.Gsql.execute("ls"))

Code Linting And Unit Testing

Code Linting :

Linting using PEP8 Standards

user@box:~$ flake8 --exclude=venv* --ignore=E501 --statistics pyTigerDriver/pyDriver.py

Running the tests :

run unit tests using pytest :

user@box:~$ pytest -v

CircleCi Work flow :

  1. create a folder named .circleci in the root of the repo
  2. within that folder create a file called config.yml containing the folloing flow :
version: 2.1

orbs:
  python: circleci/python@0.2.1


jobs:
  build-and-test:
    executor: python/default
    steps:
      # Step 1: obtain repo from GitHub
      - checkout
      # Step 2: create virtual env and install dependencies
      - run:
          name: install dependencies
          command: |
            python3 -m venv venv
            . venv/bin/activate
            pip install -r requirements.txt
      # Step 3: run linter and tests
      - run:
          name: run tests
          command: |
            . venv/bin/activate
            flake8 --exclude=venv* --ignore=E501  --statistics pyTigerDriver/pyDriver.py
            pytest -v


workflows:
  main:
    jobs:
      - build-and-test

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

pyTigerDriver-1.0.15.tar.gz (11.5 kB view hashes)

Uploaded source

Built Distribution

pyTigerDriver-1.0.15-py3-none-any.whl (12.0 kB view hashes)

Uploaded py3

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