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 grpah 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

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.1.tar.gz (5.3 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.1-py3-none-any.whl (824.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pymogwai-0.0.1.tar.gz
  • Upload date:
  • Size: 5.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pymogwai-0.0.1.tar.gz
Algorithm Hash digest
SHA256 7c1ea78aad907a68094131ab0e4be0d56b70a507b8e9f4c018a994c48882b257
MD5 41513c8e5c4572730176570ca8ff8ae3
BLAKE2b-256 7b044740702717a514aa1275d52c5fa6f532bdac284fc13fea470ba5f6ac3ede

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pymogwai-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 824.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pymogwai-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8cf45132eb851fed69cfe6492a868de251828d247f564ad5a31f968ac9f0b2f9
MD5 48b39318eb416ab2131acbefe873cfe5
BLAKE2b-256 6fa38180747235f975c8a2356715a0307e2cca3b957ab37d92620e3a74efa737

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