Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A tool to visualize include graphs for C++ projects

Project description

# :fireworks: ig

<p align="center">
<img src="extra/graph.gif">
<br><br>
<code>ig</code> is a tool to interactively visualize include graphs for C++ projects
<br><br>
<img alt="license" src="https://img.shields.io/github/license/mashape/apistatus.svg"/>
</p>

## Overview

Point `ig` at any directory containing C++ source or header files and it will
construct a full graph of all includes, serve you a local website and visualize
the graph interactively with [sigma.js](http://sigmajs.org), for you to admire.

Usage is very easy:

```sh
$ ig -o include
```

will inspect the folder `include`, serve a website on `localhost:8080` and even
open your browser for you. The full set of options currently include:

```sh
usage: ig [-h] [--pattern PATTERNS] [-i PREFIXES] [-v] [-p PORT] [-o] [-j]
[-d DIRECTORY] [--relation {includes,included-by}]
[--min-degree MIN_DEGREE] [--group-granularity GROUP_GRANULARITY]
[--full-path] [--colors COLORS] [--color-variation COLOR_VARIATION]
[--color-alpha-min COLOR_ALPHA_MIN]
directories [directories ...]

Visualize C++ include graphs

positional arguments:
directories The directories to look at

optional arguments:
-h, --help show this help message and exit
--pattern PATTERNS The file (glob) patterns to look for
-i PREFIXES, -I PREFIXES, --prefix PREFIXES
An include path for headers to recognize
-v, --verbose Whether to turn on verbose output
-p PORT, --port PORT The port to serve the visualization on
-o, --open Whether to open the webpage immediately
-j, --json Whether to print the graph JSON and not serve it
-d DIRECTORY, --dir DIRECTORY
The directory to store the served files in. Ifnot
supplied, a temporary directory is created.
--relation {includes,included-by}
The relation of edges in the graph
--min-degree MIN_DEGREE
The initial minimum degree nodes should have to be
displayed
--group-granularity GROUP_GRANULARITY
How coarse to group nodes (by folder)
--full-path If set, shows the full path for nodes
--colors COLORS The base RGB colors separated by commas
--color-variation COLOR_VARIATION
The variation in RGB around the base colors
--color-alpha-min COLOR_ALPHA_MIN
The minimum alpha value for colors
```

But does it scale? It scales quite well. The graph you see above is the include
graph for the entire LLVM and clang codebase, which spans more than 5,000 files
and 1.5M LOC. Note that the visualization also includes sliders to group nodes
by folder and filter out low-degree nodes.

## Installation

Get it with pip:

```sh
$ pip install ig-cpp
```

Works with Python 2 and 3.

## Examples

Who ever said C++ was an ugly language?

<p align="center">
<img src="extra/llvm-adt.png">
<br><br>
<b>LLVM/ADT</b>
<br><br>
</p>

<p align="center">
<img src="extra/tf.png">
<br><br>
<b>TensorFlow</b>
<br><br>
</p>

<p align="center">
<img src="extra/libcxx.png">
<br><br>
<b>libc++ (the standard library)</b>
<br><br>
</p>

## Authors

[Peter Goldsborough](http://goldsborough.me) + [cat](https://goo.gl/IpUmJn)
:heart:

Project details


Release history Release notifications

This version
History Node

0.1.9

History Node

0.1.8

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ig_cpp-0.1.9-py2.py3-none-any.whl (96.7 kB) Copy SHA256 hash SHA256 Wheel py2.py3 May 11, 2017
ig-cpp-0.1.9.tar.gz (86.7 kB) Copy SHA256 hash SHA256 Source None May 11, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page