Skip to main content

Graphinate. Data to Graphs.

Graphinate. Data to Graphs.

Package PyPI - version PyPI - Status PyPI - Python Version PyPI - Downloads
GitHub GitHub repo size GitHub last commit (by committer) Contributors
CI/CD Tests Publish Publish Docs
Scans Quality Gate Status Security Rating Maintainability Rating Reliability Rating
Lines of Code Vulnerabilities Bugs
Coverage Codacy Badge

Introduction

What is Graphinate?

Graphinate is a python library that aims to simplify the generation of 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 easily map data payloads and hierarchies to a Graph.

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

Graphinate utilizes and builds upon the excellent NetworkX.


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.9+.

Example

import graphinate

N: int = 8

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


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


# Materialize the GraphModel
graphinate.materialize(graph_model)

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

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.

Python AST

d3_graph_ast

GitHub Repository

repo_graph

Python AST - 3D Force-Directed Animation

AST 3D Force animation

Development

Ruff

ruff check src

Test

Standard (cobertura) XML Coverage Report

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

HTML Coverage Report

 python -m pytest tests --cov=src --cov-branch --doctest-modules --cov-report=html --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.

Dev Tools

Hatch logo. pytest logo. Ruff logo.

IDE

PyCharm logo.

Metadata

Release files for Graphinate 0.2.2

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.2.2
File Size Uploaded Provenance Actions
graphinate-0.2.2.tar.gz 247.5 kB Without provenance Details for graphinate-0.2.2.tar.gz

Built distribution (wheel)

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

Total release size: 319.4 kB

Release files / graphinate-0.2.2.tar.gz

Download URL graphinate-0.2.2.tar.gz
Size 247.5 kB
Tags Source
SHA-256 checksum
How to use checksums
5351405e35b41f8be71463e9e3f9a9db12f0bfb362e10c7daecb5a1fb72d1721
BLAKE2b-256 checksum
How to use checksums
910768e40f8305d93dc25570f45eed486fffc6e032457b2921d500940c492bd5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

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

Download URL graphinate-0.2.2-py3-none-any.whl
Size 71.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
12252c16ea79367f32ba152442c3094638758568b75a4452c7f8a7a522d8c40b
BLAKE2b-256 checksum
How to use checksums
1151f7e2c7fb36cddb7f98502ec005dfa8ce0c35ac289564a284039f21ba33d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Security for Graphinate 0.2.2

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