Skip to main content

Graphinate. Data to Graphs.

Graphinate. Data to Graphs.
Package PyPI - version PyPI - Status PyPI - Python Version PyPI - Downloads Libraries.io SourceRank
Code GitHub GitHub repo size GitHub last commit (by committer) Contributors
Tools PyCharm uv ruff pipdeptree mkdocs-material Hatch project
CI/CD Test Test (Beta) Publish Publish Docs
Scans Coverage Quality Gate Status Security Rating Maintainability Rating Reliability Rating Lines of Code Vulnerabilities Bugs Codacy Badge Codacy Coverage Scrutinizer CodeFactor Snyk
Mentions PythonBytes Podcast Static Badge
Badge Graphinate

Table of Contents

Introduction

What is Graphinate?

Graphinate is a python library that can be used to generate Graph Data Structures from Data Sources.

It can help create an efficient retrieval pipeline from a given data source, while also enabling the developer to map data payloads and hierarchies to a Graph.

In addition, there are several modes of output to enable examination of the Graph and its content.

Graphinate uses and builds upon the excellent NetworkX.

Links

Quick Start

Install

Graphinate is available on PyPI:

pip install graphinate

To install with server support

pip install graphinate[server]

Graphinate officially supports Python >= 3.10.

Example

import examples.math.materializers
import graphinate

N: int = 8

# Define a GraphModel
graph_model: graphinate.GraphModel = graphinate.model(name="Octagonal Graph")


# Register in the Graph Model the edges' supplier function
@graph_model.edge()
def edge():
    for i in range(N):
        yield {'source': i, 'target': i + 1}
    yield {'source': N, 'target': 0}


# Choose builder and handler
builder, handler = examples.math.materializers.Materializers.NetworkX_with_edge_labels.value

# Use the NetworkX Builder
builder = graphinate.builders.NetworkxBuilder(graph_model)

# build the NetworkX graph
graph = builder.build()

# plot the graph using matplotlib
graphinate.plot(graph, with_edge_labels=True)

graphinate.model function

[!NOTE] This function creates GraphModel class that is used to declaratively register Edge and/or Node data supplier functions by using the GraphModel.node() and GraphModel.edge() decorators.

CLI

Commands

Usage: python -m graphinate [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  save
  server

Save

Usage: python -m graphinate save [OPTIONS]

Options:
  -m, --model MODEL  A GraphModel instance reference {module-
                     name}:{GraphModel-instance-variable-name} For example,
                     given var `model=GraphModel()` defined in app.py file,
                     then the  reference should be app:model
  --help             Show this message and exit.

Server

TIP: requires the server extra to be installed. e.g., pip install graphinate[server]

Usage: python -m graphinate server [OPTIONS]

Options:
  -m, --model MODEL   A GraphModel instance reference {module-
                      name}:{GraphModel-instance-variable-name} For example,
                      given var `model=GraphModel()` defined in app.py file,
                      then the  reference should be app:model
  -p, --port INTEGER  Port number.
  --help              Show this message and exit.

Gallery

Python AST

d3_graph_ast

GitHub Repository

repo_graph

Python AST - 3D Force-Directed Animation

Web Page Links

Web Page Links

Development

Install dependencies

Use UV to install all dependencies

uv sync --all-extras --all-groups

Update dependencies

uv lock --upgrade
uv sync --all-extras --all-groups

Ruff

Report issues

ruff check src

Fix issues

ruff check src --fix

Test

Standard (cobertura) XML Coverage Report

 python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=xml --junitxml=test_results.xml

HTML Coverage Report

python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=html --junitxml=test_results.xml

Terminal Coverage Report

python -m pytest tests -n auto --cov=src --cov-branch --doctest-modules --cov-report=term --junitxml=test_results.xml

Docs

test

python -m mkdocs serve

build

python -m mkdocs build

Acknowledgements

Dependencies

Python

Click Logo Loguru Logo matplotlib Logo. NetworkX Logo. Strawberry GraphQL Logo

Javascript and HTML

3D Force-Directed Graph Logo Graphql Voyager Logo Tweakpane Logo

Dev Tools

Hatch logo. Material for MkDocs pytest logo Ruff logo uv logo

IDE

PyCharm logo


Alt


Star Chart

Copyright © 2023-2025 Eran Rivlis

Metadata

Release files for Graphinate 0.8.0

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

Source distribution (sdist)

Source distribution for Graphinate 0.8.0
File Size Uploaded Provenance Actions
graphinate-0.8.0.tar.gz 2.3 MB Without provenance Details for graphinate-0.8.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for Graphinate 0.8.0
File Interpreter ABI Platform Actions
graphinate-0.8.0-py3-none-any.whl Python 3 none any Details for graphinate-0.8.0-py3-none-any.whl

Total release size: 2.4 MB

Release files / graphinate-0.8.0.tar.gz

Download URL graphinate-0.8.0.tar.gz
Size 2.3 MB
Tags Source
SHA-256 checksum
How to use checksums
26ab0c6f1d2df2fb2072bf5f165a2b364d8df8409d472475795a868e0d7affb8
BLAKE2b-256 checksum
How to use checksums
0963b9bdbf40ec576172ca63fe116eccb540de56dcab2ccc0852a45a70634238
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release files / graphinate-0.8.0-py3-none-any.whl

Download URL graphinate-0.8.0-py3-none-any.whl
Size 110.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d49ff508605359ca4774a764a1ae74042e575838afeeefee13156d76f6a26364
BLAKE2b-256 checksum
How to use checksums
da6980a4c88c5936d2dc05f63cf529123a5a9e7c329ebb75cc83af3ea26dcbef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Security for Graphinate 0.8.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A 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.

Release history Release notifications | RSS feed

This release

0.8.0 This release

2 release files No provenance

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