Metadata-Version: 2.1
Name: submodulegraph
Version: 0.1.5
Summary: Visualize Git Submodule Graphs
Home-page: https://github.com/bacox/submodule-graph
Author: Bart Cox
Author-email: bartcox93@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: pydot
Requires-Dist: configparser

# Submodule Graph
Visualize Git Submodule Graphs

## Install
```
$ pip install submodulegraph
```

## Usage
```
$ submodulegraph --help

Usage: submodulegraph [OPTIONS] REPO

Options:
  -m, --mode TEXT       Output Mode: text | png  [default: text]
  -g, --graphmode TEXT  GraphMode: scattered | clustered  [default: scattered]
  -o, --out TEXT        Image filename  [default: graph]
  --help                Show this message and exit.
```

```
Examples:
# (Default) print the structure of the submodules in text in the console.
$ submodulegraph <path to repo>

# Create a png of the submodule structure where all the submodules are listed separately.
$ submodulegraph -m png <path to repo>

# Create a png of the submodule structure where all the submodules are only listed once.
$ submodulegraph -m png -g clustered <path to repo>
```

