ssl-metrics-git-commits-loc 0.6.4

SSL Metrics - Git History (LOC/KLOC) Analysis

SSL Metrics Git LOC Timeline

Using Git, provide insight into a branches commit LOC changes over time

Table of Contents

• SSL Metrics Git LOC Timeline
  • Table of Contents
  • About
  • How to Run
    • Note on Command Line Arguments
    • From pip
    • Command Line Arguments
      • ssl-metrics-git-commits-loc
      • ssl-metrics-git-commits-graph
        • Note on Graph Export Options

About

This project is a proof of concept demonstration that it is possible to generate useful insights into a Git project via the git command line interface.

Currently, this project generates a graph of:

• Number of lines of code against days

How to Run

Note on Command Line Arguments

See Command Line Arguments for program configuration from the command line

From pip

1. Install Python 3.9.6 +
2. (Recommended) Create a virtual environment with python3.9 -m venv env and activate it
3. Run pip install ssl-metrics-git-commits-loc
4. Generate a JSON data set with ssl-metrics-git-commits-loc -d DIRECTORY -b BRANCH -s FILENAME.json
5. Generate graphs with ssl-metrics-git-commits-graph -i FILENAME.json -o GRAPH_FILENAME.*

Command Line Arguments

ssl-metrics-git-commits-loc

• -h, --help: Shows the help menu and exits
• -d, --directory: Directory where the .git folder is located
• -b, --branch: Git branch to analyze
• -s, --save-json: Save analysis to JSON file

ssl-metrics-git-commits-graph

Note on Graph Export Options

Arguement -o can be of any of the formats that matplotlibs.pyplot.savefig function exports to.

• -h, --help: Shows the help menu and exits
• -i, --input: The input JSON file that is to be used for graphing
• -o, --output: The filename of the output graph