Metadata-Version: 2.1
Name: sparql-visualizer
Version: 1.0.2
Summary: SPARQL query visualizer
Project-URL: Homepage, https://github.com/AlixRegnier/sparql-visualizer
Project-URL: Bug Tracker, https://github.com/AlixRegnier/sparql-visualizer/issues
Author-email: Alix Regnier <regnier.alix@outlook.com>
License-File: LICENSE
Requires-Dist: antlr4-python3-runtime==4.10
Requires-Dist: graphviz==0.20.1
Requires-Dist: networkx~=3.1
Requires-Dist: sparqldataframe==0.1.0
Requires-Dist: sparqlwrapper~=2.0.0
Description-Content-Type: text/markdown

# **sparql-visualizer**

**sparql-visualizer** is a program for visualizing queries in graph form.

## **Requirements**

Before using the program, make sure that your environment is compatible by submitting ``requirements.txt`` to **pip** with:

```bash
pip3 install -r requirements.txt
```

## **Usage**

<!-- main.py may be changed for another filename, and imported python files may be moved into a new directory -->
Command line|
--|
``python3 main.py (-a \| [-gmrs]) [-e E] [-M dir] [-O dir] [-v] <FILES>``

*files* either can be a set of file or directories containing *.rq

### **Arguments**

Argument|Long|Value|Description
:--:|:--:|:--:|--
-a|--all|-|Alias using -g -m -r -s
-e||E|Change query extension from ".rq" to \<E>
-g|--graph|-|Render graph
-m|--mcs|-|Calculate all MCS (<a href="https://en.wikipedia.org/wiki/Maximum_common_induced_subgraph">*maximum common induced subgraphs*</a> )
-M||dir|Modify output directory for MCS to \<dir> (*default:* `./mcs_result` )
-O||dir|Modify output directory for rendering to \<dir> (*default:* `query directory` )
-r|--relation|-|Render relation graph
-s|--simple|-|Render simplified graph
-v|--verbose|-|Verbose

*Examples:*
```bash
#Rendering graphs, simplified graphs, relation graphs and MCS
python3 main.py -g -m -r -s ./queries
python3 main.py -gmrs ./queries/*.rq
python3 main.py -a ./queries/*.rq
```

```bash
#Change default input extension
python3 main.py -a -e .txt ./queries ./otherqueries
python3 main.py -a ./queries/*.txt ./otherqueries/*.txt
```

```bash
#Change output directories
python3 main.py -a ./queries -M ./mcs -O ./render
```