wily icon indicating copy to clipboard operation
wily copied to clipboard

standardized, reusable output formats (e.g json and png)

Open danwos opened this issue 5 years ago • 9 comments

Providing more standardized output formats for diff, report and graph to support the development of tools on top of wily.

To embedded the wily results automatically (CI) in other tools/documents, a machine readable format would be great.

use cases

The graph output could be easily integrated into word-docs or wiki-pages, if png as output format is supported.

The report and diff output as json string/file would allow a CI to evaluate the results during build and maybe reject a commit because of too high complexity.

my motivation

I'm personally thinking of creating an extension for sphinx: sphinx-wily. To get the wily results easily into a documentation during build time. But I want to avoid parsing any kind of cli-output, if it is not using any standard (too risky that such an output gets changed over time).

I may find some time to dive into wily and provide a PR which implements at least a json output. But no guarantee for this.

So any thoughts or concerns regarding additional output formats?

BTW: Thanks for this great tool. Performing an analysis over the git history is really an awesome feature.

danwos avatar Oct 23 '19 05:10 danwos