Graphinate 0.0.9

Graphinate. Data to Graphs.

Graphinate. Data to Graphs.

[!WARNING] UNDER DEVELOPMENT

This library is alpha-quality

Introduction

What is Graphinate?

Graphinate is a library that aims to simplify the generation of Graph Data Structures from Data Sources.

It utilizes and builds upon the excellent NetworkX library.

In addition, it has several interfaces for ease of use:

• CLI (using Click),
• GraphQL API (using Strawberry GraphQL).

Install

Graphinate is available on PyPI:

pip install graphinate

To install with server support

pip install graphinate[server]

Graphinate officially supports Python 3.9+.

Quick Start

GraphModel

Graphinate defines the GraphModel Class which can be used to declaratively register Edge and/or Node data supplier functions by using decorators.

materialize

Graphinate supplies a materialize function to output the GraphModel.

Example

import graphinate

N: int = 8

# Define GraphModel
graph_model = graphinate.GraphModel(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] MODEL

Options:
  --help  Show this message and exit.

Server

Usage: python -m graphinate server [OPTIONS] MODEL

Options:
  -p, --port INTEGER
  --help              Show this message and exit.

TUI

UNDER DEVELOPMENT

Gallery

Python AST

GitHub Repository

Python AST - 3D Force-Directed Animation

Development

Lint

ruff check src

Docs

python -m mkdocs build

Build

python -m build

Test

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

Acknowledgements

Dependencies

Python

Javascript and HTML

Dev Tools

IDE