Graphinate. Data to Graphs.
Project description
Graphinate. Data to Graphs.
[!WARNING]
UNDER DEVELOPMENT
This library is alpha-quality
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.
- 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.9+.
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)
[!NOTE]
graphinate.GraphModel
classThis class is used to declaratively register Edge and/or Node data supplier functions by using decorators.
graphinate.materialize
functionThis 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 dialog.
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
Development
Ruff
ruff check src
Docs
test
python -m mkdocs serve
build
python -m mkdocs build
Build
python -m build
Test
python -m pytest ./tests --cov=./src --cov-branch --doctest-modules --cov-report=xml --junitxml=test_results.xml
Acknowledgements
Dependencies
Python
Javascript and HTML
Dev Tools
IDE
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for graphinate-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 905a67b51ec4eeaddbfdc565127ed5ea507be5634352c6cea19efc33c56a04ae |
|
MD5 | 2a0f45e9cde62d1a0f37dd40ae0503be |
|
BLAKE2b-256 | 88936610cc9a14faefbd3ca9b39a354f6d891173927790a8d8e6244561e1f605 |