Description:
Graphinate 0.3.0
Graphinate. Data to Graphs.
Package
Tools
CI/CD
Scans
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.
Links
Website (including documentation): https://erivlis.github.io/graphinate
Source: https://github.com/erivlis/graphinate
Package: https://pypi.org/project/graphinate
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 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 - 1):
yield {'source': i, 'target': i + 1}
yield {'source': N - 1, 'target': 0}
# Materialize the GraphModel
graphinate.materialize(graph_model)
[!NOTE]
graphinate.model function
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.
graphinate.materialize function
This function can be used to easily generate an output from a GraphModel instance.
By default, it will prompt the user to choose the output format, using a popup GUI dialog box.
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.
Gallery
Python AST
GitHub Repository
Python AST - 3D Force-Directed Animation
Web Page Links
Development
Ruff
ruff check src
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
Docs
test
python -m mkdocs serve
build
python -m mkdocs build
Acknowledgements
Dependencies
Python
Javascript and HTML
Dev Tools
IDE
Copyright © 2023 Eran Rivlis
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
