Skip to main content

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.

Metadata

Release files for graphlit-client 1.0.20260711001

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for graphlit-client 1.0.20260711001
File Size Uploaded
graphlit_client-1.0.20260711001.tar.gz 301.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for graphlit-client 1.0.20260711001
File Interpreter ABI Platform
graphlit_client-1.0.20260711001-py3-none-any.whl Python 3 none any Details

Total release size: 829.1 kB

Release files / graphlit_client-1.0.20260711001.tar.gz

Download URL graphlit_client-1.0.20260711001.tar.gz
Size 301.9 kB
Tags Source
SHA-256 checksum
How to use checksums
65d082d93a0e5370ae9c8aa4cfb0a758888cdcb24b63f234ce37adeecac65d6e
BLAKE2b-256 checksum
How to use checksums
b01c77aa03a872dd0cfcb45285c574ee7bae5faebcd0b7549fdc7126a526a1de
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6

Release files / graphlit_client-1.0.20260711001-py3-none-any.whl

Download URL graphlit_client-1.0.20260711001-py3-none-any.whl
Size 527.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4f2893d53f436e3756eefcd2179da477b13ff2f64f3ec6a98bdce8be8e668025
BLAKE2b-256 checksum
How to use checksums
9b833b546ba3ff0011b6f2a85b0b3d8240def2e51b5ded4632aba5aacad6694a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.6

Release history Release notifications | RSS feed

This release

1.0.20260711001 This release

2 release files

0.1.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page