Graph Command

The graph command generates HTML graphs for metrics, trends and data in the wily cache. The wily cache must be built first using the Build Command.

Examples

wily graph will take 1 or 2 metrics as the 2nd and 3rd arguments. The first metric will be the Y-axis and the 3rd metric (if provided) will control the size of the bubble.

$ wily graph example.py loc
../_images/single_metric_graph.png

You can provide a second metric which will be used to control the size of the bubbles on the scatter diagram.

$ wily graph example.py loc complexity
../_images/two_metric_graph.png

The x-axis will be the historic revisions (typically git commits) on a scale of the revision date. You can change the x-axis to a specific metric. If you do so, the color of the bubble will get darker as the revisions go from 0-n, where n is the last revision.

$ wily graph example.py loc complexity --x-axis sloc
../_images/custom_x_axis_graph.png

By default, wily graph will create a file, wily-report.html in the current directory and open it using the browser configured in the $BROWSER environment variable (the default on the OS). To save the output to a specific HTML file and not open it, provide the -o flag and the name of the output file.

$ wily report example.py loc -o example.html

Command Line Usage

wily

Graph a specific metric for a given file, if a path is given, all files within path will be graphed.

Some common examples:

Graph all .py files within src/ for the raw.loc metric

$ wily graph src/ raw.loc

Graph test.py against raw.loc and cyclomatic.complexity metrics

$ wily graph src/test.py raw.loc cyclomatic.complexity

Graph test.py against raw.loc and raw.sloc on the x-axis

$ wily graph src/test.py raw.loc –x-axis raw.sloc
wily [OPTIONS] PATH METRICS...

Options

-o, --output <output>

Output report to specified HTML path, e.g. reports/out.html

-x, --x-axis <x_axis>

Metric to use on x-axis, defaults to history.

-a, --changes, -c, --all

All commits or changes only

Arguments

PATH

Required argument

METRICS

Required argument(s)