Skip to main content

PyMogwai is a Python-based implementation of the Gremlin graph traversal language, designed to create and handle knowledge graphs entirely in Python without the need for an external Gremlin server.

Project description

PyMogwai

PyMogwai is a Python-based implementation of the Gremlin graph traversal language, designed to create and handle knowledge graphs entirely in Python without the need for an external Gremlin server.

pypi Github Actions Build PyPI Status GitHub issues GitHub closed issues API Docs License

Features

  • Supports knowledge graph creation and manipulation
  • Supports the import of arbitrary knowledge graphs with GraphML
  • Implements a variety of traversal steps
  • Enables one to traverse a graph with these steps
  • Ability to integrate data from various sources like Excel, PDF and PowerPoint
  • Simple and Pythonic API for graph operations

Demo

nicegui based demo

Getting started

Creating a Knowledge Graph

To create a graph using PyMogwai

from mogwai.core import MogwaiGraph
graph = MogwaiGraph()

# Add nodes and edges
n1 = graph.add_labeled_node("person", name="Alice", properties={"Age": 30})
n2 = graph.add_labeled_node("person", name="Bob", properties={"Age": 28})
graph.add_labeled_edge(n1, n2, "knows")

Import graphs

from mogwai.parser.graphml_converter import graphml_to_mogwaigraph

graph = graphml_to_mogwaigraph(path, node_label_key="node_label", node_name_key="node_name", edge_label_key="edge_label")

Performing Traversals

To perform any traversal of the graph, create a TraversalSource. Traversals start with a start step (V() or E()), which is followed by a sequence of steps. Note that a traversal can be executed by calling .run() on it.

from mogwai.core.traversal import MogwaiGraphTraversalSource

g = MogwaiGraphTraversalSource(graph)

# Example traversal that returns every person in the graph as a list
res = g.V().has_label("person").to_list().run()
print(res)

In order to use anonymous traversal in complex queries, import the statics module:

from mogwai.core.traversal import MogwaiGraphTraversalSource
from mogwai.core.steps.statics import *

g = MogwaiGraphTraversalSource(graph)

# Example traversal that returns every person in the graph as a list
query = g.V().has_label("person").filter_(properties('age').is_(gte(30))).to_list().by('name')
res = query.run()
print(res)

History

This project started as part of the RWTH Aachen i5 Knowledge Graph Lab SS2024 The original source is hosted at https://git.rwth-aachen.de/i5/teaching/kglab/ss2024/pymogwai 2024-08-15 the repository moved to github for better pypi integration

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymogwai-0.0.2.tar.gz (6.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymogwai-0.0.2-py3-none-any.whl (963.6 kB view details)

Uploaded Python 3

File details

Details for the file pymogwai-0.0.2.tar.gz.

File metadata

  • Download URL: pymogwai-0.0.2.tar.gz
  • Upload date:
  • Size: 6.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pymogwai-0.0.2.tar.gz
Algorithm Hash digest
SHA256 efebdc66c9a7c87bbad4ee521aea152356a82216027a86fd74914d099d56141f
MD5 7596d12458bd5baa33ef5855d7c145a2
BLAKE2b-256 1397f74ec4aa239eea64bd92a8cb89f2340ad085a88ffa711db5894b9e0d172d

See more details on using hashes here.

File details

Details for the file pymogwai-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: pymogwai-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 963.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pymogwai-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 224d42d88aff33e3298b2518548275cf28a7d9920ec97abda2baca1a47cd9c77
MD5 3a724afee6dee61f233114ba5e992058
BLAKE2b-256 bda5c8bcbbd06b30fc9f61dcdfd7de0f7bc75c1158c3091eecfabb447639272b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page