Module Map Visualizer

This repository contains some python scripts which purpose is to generate a graphical representation of the relationships module-submodule existing between the repositories of a GitHub organization.

Requirements

In order to be able to use this python script, you need to have the following elements installed:

• gh, GitHub command line interface
  • with the copy file extension: gh extension install mislav/gh-cp

You also need to install the python package detailed in the requirements.txt file, for example, by running the following command:

pip install -r requirements.txt

Usage

# Basic use case
python scripts/repository_dependencies.py -o < name_of_your_github_organization >

# Basic use case with private repositories
python scripts/repository_dependencies.py -o < name_of_your_github_organization > --with-private-repository

# Basic use case with a specified output folder
python scripts/repository_dependencies.py -o < name_of_your_github_organization > --output-folder < path/to/folder >

# Display the help
python scripts/repository_dependencies.py --help

Be careful, the private repositories of the GitHub organization will be displayed in the graph generated, if you have the GitHub access to those repositories. Take that information into account if you plan on sharing the generated graphs 😉