graphlit-client 1.0.20250104001

Graphlit API Python Client

Python Client for Graphlit Platform

Overview

The Graphlit Client for Python enables easy interaction with the Graphlit API, allowing developers to execute queries and mutations against the Graphlit service. This document outlines the setup process and provides a basic example of using the client.

Prerequisites

Before you begin, ensure you have the following:

• Python 3.x installed on your system.
• An active account on the Graphlit Platform with access to the API settings dashboard.

Installation

To install the Graphlit Client, use pip:

pip install graphlit-client

Configuration

The Graphlit Client supports environment variables to be set for authentication and configuration:

• GRAPHLIT_ENVIRONMENT_ID: Your environment ID.
• GRAPHLIT_ORGANIZATION_ID: Your organization ID.
• GRAPHLIT_JWT_SECRET: Your JWT secret for signing the JWT token.

Alternately, you can pass these values with the constructor of the Graphlit client.

You can find these values in the API settings dashboard on the Graphlit Platform.

For example, to use Graphlit in a Google Colab notebook, you need to assign these properties as Colab secrets: GRAPHLIT_ORGANIZATION_ID, GRAPHLIT_ENVIRONMENT_ID and GRAPHLIT_JWT_SECRET.

import os
from google.colab import userdata
from graphlit import Graphlit

os.environ['GRAPHLIT_ORGANIZATION_ID'] = userdata.get('GRAPHLIT_ORGANIZATION_ID')
os.environ['GRAPHLIT_ENVIRONMENT_ID'] = userdata.get('GRAPHLIT_ENVIRONMENT_ID')
os.environ['GRAPHLIT_JWT_SECRET'] = userdata.get('GRAPHLIT_JWT_SECRET')

graphlit = Graphlit()

Setting Environment Variables

To set these environment variables on your system, use the following commands, replacing your_value with the actual values from your account.

For Unix/Linux/macOS:

export GRAPHLIT_ENVIRONMENT_ID=your_environment_id_value
export GRAPHLIT_ORGANIZATION_ID=your_organization_id_value
export GRAPHLIT_JWT_SECRET=your_secret_key_value

For Windows Command Prompt (CMD):

set GRAPHLIT_ENVIRONMENT_ID=your_environment_id_value
set GRAPHLIT_ORGANIZATION_ID=your_organization_id_value
set GRAPHLIT_JWT_SECRET=your_secret_key_value

For Windows PowerShell:

$env:GRAPHLIT_ENVIRONMENT_ID="your_environment_id_value"
$env:GRAPHLIT_ORGANIZATION_ID="your_organization_id_value"
$env:GRAPHLIT_JWT_SECRET="your_secret_key_value"

Support

Please refer to the Graphlit API Documentation.

For support with the Graphlit Client, please submit a GitHub Issue.

For further support with the Graphlit Platform, please join our Discord community.