<commit_before>image::https://raw.githubusercontent.com/dkuppitz/sparql-gremlin/master/static/sparql-gremlin-logo.png[SPARQL-Gremlin]

SPARQL-Gremlin
==============

SPARQL-Gremlin is a compiler used to transform SPARQL queries into Gremlin traversals. It is based on the https://jena.apache.org/index.html[Apache Jena] SPARQL processor https://jena.apache.org/documentation/query/index.html[ARQ], which provides access to a syntax tree of a SPARQL query.

The current version of SPARQL-Gremlin only uses a subset of the features provided by Apache Jena. The examples below show each implemented feature.

Quick Start
-----------

Console Application
~~~~~~~~~~~~~~~~~~~

The project contains a console application that can be used to compile SPARQL queries and evaluate the resulting Gremlin traversals. For usage examples simply run `${PROJECT_HOME}/bin/sparql-gremlin.sh`.

Gremlin Shell Plugin
~~~~~~~~~~~~~~~~~~~~

To use Gremlin-SPARQL as a Gremlin shell plugin, run the following commands:

[source]<commit_msg>README updates -- CLASSPATH note and fixed logo URL.<commit_after>image::https://raw.githubusercontent.com/dkuppitz/sparql-gremlin/master/docs/images/sparql-gremlin-logo.png[SPARQL-Gremlin]

SPARQL-Gremlin
==============

SPARQL-Gremlin is a compiler used to transform SPARQL queries into Gremlin traversals. It is based on the https://jena.apache.org/index.html[Apache Jena] SPARQL processor https://jena.apache.org/documentation/query/index.html[ARQ], which provides access to a syntax tree of a SPARQL query.

The current version of SPARQL-Gremlin only uses a subset of the features provided by Apache Jena. The examples below show each implemented feature.

Quick Start
-----------

Console Application
~~~~~~~~~~~~~~~~~~~

The project contains a console application that can be used to compile SPARQL queries and evaluate the resulting Gremlin traversals. For usage examples simply run `${PROJECT_HOME}/bin/sparql-gremlin.sh`.

Gremlin Shell Plugin
~~~~~~~~~~~~~~~~~~~~

To use Gremlin-SPARQL as a Gremlin shell plugin, run the following commands (be sure sparql-gremlin-xyz.jar is in the classpath):

[source]
{'fraction_non_alphanumeric': 0.12611345522737927, 'fraction_numerical': 0.0, 'mean_word_length': 4.911357340720222, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2919138', 'n_tokens_mistral': 629, 'n_tokens_neox': 591, 'n_words': 221}