DataGraphs Python Client
Python client library for DataGraphs.
Installation
uv add pydatagraphs
or
pip install pydatagraphs
Quick starts
from datagraphs import Client
# Connect to a project
client = Client(
project_name="my-project",
api_key="your-api-key",
)
# Check the API is reachable
print(client.status())
# Retrieve all entities of a given type
products = client.get("Product")
# Query with filters and pagination
results = client.query(q="Acme", page_size=50)
from datagraphs import Client
# Connect to a project
client = Client(
project_name="my-project",
api_key="your-api-key",
client_id="your-client-id",
client_secret="your-client-secret"
)
# Read the project schema and dataset configurations
schema = client.get_schema()
datasets = client.get_datasets()
# Update the project schema and dataset configurations
client.apply_schema(schema)
client.apply_datasets(datasets)
import json
from datagraphs import Client, Gateway, Schema, Dataset
# Connect to a project
client = Client(
project_name="my-project",
api_key="your-api-key",
client_id="your-client-id",
client_secret="your-client-secret"
)
gateway = Gateway(client)
# Load / dump data via the Gateway
gateway.dump_data("./backup")
gateway.load_data(from_dir_path="./backup")
# Load / dump project via the Gateway
schema_output_path = "./schemas/"
datasets_output_path = "./datasets/"
gateway.dump_project(schema_output_path, datasets_output_path)
with open("./schemas/myproject-model-v1.0.json") as f:
schema_data = json.load(f)
with open("./datasets/myproject-datasets-v1.0.json") as f:
datasets_data = json.load(f)
schema = Schema.create_from(schema_data)
datasets = [Dataset.create_from(d) for d in datasets_data]
gateway.load_project(schema, datasets)
For full API documentation, please see here
Authentication
For read-only access, an API key is sufficient. For write operations, supply OAuth credentials as well:
client = Client(
project_name="my-project",
api_key="your-api-key",
client_id="your-client-id",
client_secret="your-client-secret",
)
Key classes
| Class | Description |
|---|---|
Client |
HTTP client for the DataGraphs REST API |
Gateway |
Higher-level wrapper class for deploying projects and bulk export/load of data |
Schema |
In-memory representation of a project's domain model |
Dataset |
Represents a dataset within a project |
Development
Install uv, then:
uv sync # create virtualenv & install deps
uv run pytest tests -v # unit tests
uv run pytest tests_integration -v # integration tests
uv run pytest tests -v --capture=tee-sys # capturing stdout/stderr
uv run pytest --cov=src --cov-report=html # coverage report
uvx ruff check . # lint
License
MIT — Copyright (c) 2026 Data Language
1 maintainer
Metadata
1 maintainer
Release files for pydatagraphs 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pydatagraphs-0.6.1.tar.gz | 55.5 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pydatagraphs-0.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 115.5 kB
Release files / pydatagraphs-0.6.1.tar.gz
| Download URL | pydatagraphs-0.6.1.tar.gz |
|---|---|
| Size | 55.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
85fa91b1ec72eccbea776517361bd6635f35de0b49130dc3a84315876620613a
|
|
BLAKE2b-256 checksum How to use checksums |
f8689619c664027ea8c4ad2d38fe7c70cd5f173c236e2298c7498e8aa468bd7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 28, 2026.
Transparency logRelease files / pydatagraphs-0.6.1-py3-none-any.whl
| Download URL | pydatagraphs-0.6.1-py3-none-any.whl |
|---|---|
| Size | 60.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3e0b90e5d366ecbc6c0a53c890d4b80b653aa2087c22ef2a373498b45e82f678
|
|
BLAKE2b-256 checksum How to use checksums |
78a94b23a7321d62e6fd371a3bb88d3586eb29859c5bae8c80fabfad92b44c05
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 28, 2026.
Transparency logSecurity for pydatagraphs 0.6.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for pydatagraphs-0.6.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 28, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
