Graphlit API Python Client
Project description
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file graphlit_client-1.0.20260510001.tar.gz.
File metadata
- Download URL: graphlit_client-1.0.20260510001.tar.gz
- Upload date:
- Size: 304.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e686e25c9a05cea7f10f46307eefa550fa2e0aec69329acc2e04c7828ce510f
|
|
| MD5 |
69364db9ab4693a304bb06b67080c490
|
|
| BLAKE2b-256 |
651fc64f59005a9389a466e7df79d5df57cd4f8f4f44e72c225989ef89a7c74e
|
File details
Details for the file graphlit_client-1.0.20260510001-py3-none-any.whl.
File metadata
- Download URL: graphlit_client-1.0.20260510001-py3-none-any.whl
- Upload date:
- Size: 528.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0368088c189cefbd9e8fe651e73b15cfc5f122686ecfd23095de2c74c4ec758f
|
|
| MD5 |
3c135f57a9af2c74e454fb0e7798f2f9
|
|
| BLAKE2b-256 |
95402db71e8a2e16c51a7f62198b3331c1c8059e1a4cb74233b155ac1b153b47
|
