Software Systems Laboratory Git Productivity Project
A tool to calculate the productivity of a repository based off of committer information
![https://img.shields.io/badge/license-BSD--3-yellow](https://img.shields.io/badge/license-BSD--3-yellow)
Table of Contents
About
The Software Systems Laboratory (SSL) Git Productivity Project is a tool to calculate the productivyt metric of a git
repository.
This project is licensed under the BSD-3-Clause. See the LICENSE for more information.
Developer Tooling
To maximize the utility of this project and the greater SSL Metrics project, the following software packages are required:
Operating System
All tools developed for the greater SSL Metrics project must target Mac OS and Linux. SSL Metrics software is not supported or recommended to run on Windows but can be modified to do so at your own risk.
It is recomendded to develop on Mac OS or Linux. However, if you are on a Windows machine, you can use WSL to develop as well.
How To Use
Installation
You can install this tool with one of the following one liners:
pip install --upgrade pip ssl-metrics-meta
pip install --upgrade pip ssl-metrics-git-productivity
Shell Commands
ssl-metrics-git-productivity-compute -h
options:
-h, --help show this help message and exit
-i INPUT, --input INPUT
JSON file containing data formatted by ssl-metrics-git-commits-loc-extract
-o OUTPUT, --output OUTPUT
JSON file containing data outputted by the application
ssl-metrics-git-productivity-graph -h
options:
-h, --help show this help message and exit
-i INPUT, --input INPUT
The input data file that will be read to create the graphs
-o OUTPUT, --output OUTPUT
The filename to output the bus factor graph to
-m MAXIMUM_DEGREE_POLYNOMIAL, --maximum-degree-polynomial MAXIMUM_DEGREE_POLYNOMIAL
Estimated maximum degree of polynomial
-r REPOSITORY_NAME, --repository-name REPOSITORY_NAME
Name of the repository that is being analyzed
--x-window-min X_WINDOW_MIN
The smallest x value that will be plotted
--x-window-max X_WINDOW_MAX
The largest x value that will be plotted