clime-productivity 0.4.2

CLIME - Productivity

CLIME Productivity

A tool to calculate the productivity of a Git repository

Table of Contents

• CLIME Productivity
  • Table of Contents
  • About
    • Licensing
  • How To Use
    • Installation
    • Shell Commands

About

The Software Systems Laboratory (SSL) CLIME Productivity project is a tool to calculate the productivity of a Git repository.

Licensing

This project is licensed under the BSD-3-Clause. See the LICENSE for more information.

How To Use

Installation

You can install this tool with one of the following one liners:

• pip install --upgrade pip clime-meta
• pip install --upgrade pip clime-productivity

Shell Commands

clime-productivity-compute -h

usage: CLIME Repository Productivity Calculator [-h] [-i INPUT] [-o OUTPUT]

A tool to calculate the productivity of a Git repository where productivity is
defined as: |ΔLOC| / (Repository Age)

options:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        Commits JSON file. DEFAULT: ./commits_loc.json
  -o OUTPUT, --output OUTPUT
                        Output JSON file. DEFAULT: ./productivity.json

Author(s): Nicholas M. Synovic, Matthew Hyatt, George K. Thiruvathukal

clime-productivity-graph -h

usage: CLIME Productivity 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 productivity 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: ./productivity.json
  -o OUTPUT, --output OUTPUT
                        Filename of the graph. DEFAULT: ./productivity.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, George K. Thiruvathukal