Skip to content

erivlis/graphinate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

450 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Graphinate. Data to Graphs.
Package PyPI - version PyPI - Status PyPI - Python Version PyPI - Downloads PyPI - Dependents Libraries.io SourceRank
Code GitHub GitHub repo size GitHub last commit (by committer) Contributors
Tools PyCharm uv ruff mkdocs-material mdformat Hatch project commitizen
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 CodeFactor DeepSource DeepSource Snyk
Mentions PythonBytes Podcast Static Badge
Badge Graphinate

Table of Contents

Introduction

Meet Graphinate

Graphinate turns your data into Graphs. Effortlessly.

It is a Python library designed to streamline the pipeline from raw data to structured Graph representations. With Graphinate, you can easily map complex data hierarchies and payloads directly to nodes and edges, creating an efficient retrieval system.

Whether you need to visualize relationships, analyze structure, or serve data via an API, Graphinate provides the tools to bring your graph to life.

Graphinate uses and builds upon the excellent NetworkX.

Library at a Glance

๐Ÿ“ The Architect (graphinate.modeling)

Define the blueprint of your graph by decorating simple functions that yield your data as nodes and edges.

๐Ÿ—๏ธ The Construction Crew (graphinate.builders)

Takes your graph blueprint and constructs various outputs, whether it's a queryable NetworkX object, a Mermaid diagram, or a GraphQL schema.

๐ŸŽจ The Artists (graphinate.renderers)

A suite of tools to visualize your graphs, from matplotlib plots to interactive Mermaid diagrams.

๐Ÿ“ก The Broadcaster (graphinate.server)

Instantly serve your graph data as an interactive GraphQL API, ready for consumption by web applications.

โŒจ๏ธ The Command Center (graphinate.cli)

A handy command-line tool to manage and interact with your graph definitions without writing boilerplate code.

Links

Quick Start

Install

Graphinate is available on PyPI:

pip install graphinate

or

uv add graphinate

To install with server support

pip install graphinate[server]

or

uv add graphinate[server] 

Graphinate officially supports Python >= 3.10.

Example

import graphinate

N: int = 8

# First Define a GraphModel instance.
# It will be used to hold the graph definitions
graph_model: graphinate.GraphModel = graphinate.model(name="Octagonal Graph")


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


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

# build the NetworkX GraphRepresentation
# the output in this case is a nx.Graph instance
graph = builder.build()

# this supplied plot method uses matplotlib to display the graph
graphinate.matplotlib.plot(graph, with_edge_labels=True)

# or use the Mermaid Builder
builder = graphinate.builders.MermaidBuilder(graph_model)

# to create a Mermaid diagram
diagram: str = builder.build()

# and get Markdown or single page HTML to display it
mermaid_markdown: str = graphinate.mermaid.markdown(diagram)
mermaid_html: str = graphinate.mermaid.html(diagram, title=graph_model.name)

# or use the GraphQL Builder
builder = graphinate.builders.GraphQLBuilder(.graph_model)

# to create a Strawberry GraphQL schema
schema = builder.build()

# and serve it using Uvicorn web server
graphinate.graphql.server(schema)

CLI

For detailed information on the command-line interface, please see the CLI Usage Guide in the official documentation.

Gallery

Python Class AST

matplotlib

graph_ast

3D Force-Directed Animation

GitHub Repository

repo_graph

Web Links

Web Page Links

Development

For instructions on how to set up your development environment, run tests, and contribute to the project, please see the Development Guide in the official documentation.

Acknowledgements

For a list of the dependencies and tools that make Graphinate possible, please see the Acknowledgements page in the official documentation.


Alt


Work on my Machine

Copyright ยฉ 2023-2026 Eran Rivlis

Contributors 4

  •  
  •  
  •  
  •