Description:
climeissuedensity 0.3.1
CLIME Issue Density
A tool to calculate the issue density of a Git repository by analyzing the issues of a project in it's issue tracker
Table of Contents
CLIME Issue Density
Table of Contents
About
Licensing
How To Use
Installation
Command Line Arguements
About
The Software Systems Laboratory (SSL) GitHub Issue Density Project is a python tool to calculate the issue density of a GitHub repository. It is reliant upon the output of the GitHub Issue and Git Commits tools.
Licensing
This project is licensed under the BSD-3-Clause. See the LICENSE for more information.
How To Use
Installation
You can install the tool via pip with either of the two following one-liners:
pip install --upgrade pip clime-metrics
pip install --upgrade pip clime-issue-density
Command Line Arguements
clime-issue-density-compute -h
usage: CLIME Issue Density [-h] [-c COMMITS] [-i ISSUES] [-o OUTPUT] [-v]
A tool to calculate the issue density of a repository
options:
-h, --help show this help message and exit
-c COMMITS, --commits COMMITS
Commits JSON file. DEFAULT: ./commits_loc.json
-i ISSUES, --issues ISSUES
Issues JSON file. DEFAULT: ./github_issues.json
-o OUTPUT, --output OUTPUT
Output JSON file. DEFAULT: ./issue_density.json
-v, --version Display version of the tool
Author(s): Nicholas M. Synovic, Matthew Hyatt, Sohini Thota, George K.
Thiruvathukal
clime-issue-density-graph -h
usage: CLIME Issue Density Grapher [-h] [-i INPUT] [-o OUTPUT] [--type TYPE]
[--title TITLE] [--x-label X_LABEL]
[--y-label Y_LABEL]
[--stylesheet STYLESHEET] [-v]
A tool to graph the issue density of a repository
options:
-h, --help show this help message and exit
-i INPUT, --input INPUT
JSON export from CLIME GitHub Issue Density Compute.
DEFAULT: ./issue_density.json
-o OUTPUT, --output OUTPUT
Filename of the graph. DEFAULT: ./issue_density.pdf
--type TYPE Type of figure to plot. DEFAULT: line
--title TITLE Title of the figure. DEFAULT: ""
--x-label X_LABEL X axis label of the figure. DEFAULT: ""
--y-label Y_LABEL Y axis label of the figure. DEFAULT: ""
--stylesheet STYLESHEET
Filepath of matplotlib stylesheet to use. DEFAULT: ""
-v, --version Display version of the tool
Author(s): Nicholas M. Synovic, Matthew Hyatt, Sohini Thota, George K.
Thiruvathukal
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
