SSL Metrics - Git History (LOC/KLOC) Analysis
Project description
SSL Metrics git
Commit LOC Extractor
This is a proof of concept demonstrating that it is possible to use
git
to extract various Lines of Code (LOC) data from a repository and graph various metrics from it
About
This is a proof of concept demonstrating that it is possible to use git
to extract various Lines of Code (LOC) data from a repository and graph various metrics from it.
This software extracts LOC, Delta LOC, and KLOC (LOC / 1000) for every commit within a singular branch of a local git
repository and stores it within a .json
file.
This file can then be piped into a bundled graphing utility to graph the following for LOC, Delta LOC, and KLOC:
- Actual data
- Trend line
- Velocity of trend line
- Acceleration of trend line
The graphs can be saved as a .png
, .pdf
, or any compatible format that matplotlib
supports.
How to Run
Installation
From pip
- Install
Python 3.9.6 +
- (Recommended) Create a virtual environment with
python3.9 -m venv env
and activate it - Run
pip install ssl-metrics-git-commits-loc
- Generate a JSON data set with
ssl-metrics-git-commits-loc-extract -d DIRECTORY -b BRANCH -o FILENAME.json
- Generate graphs with
ssl-metrics-git-commits-loc-graph -i FILENAME.json -l LOC_GRAPH_FILENAME.* -d DELTA_LOC_GRAPH_FILENAME.* -k K_LOC_GRAPH_FILENAME.* -m ESTIMATED_POLYNOMIAL_DEGREE -r REPOSITORY_NAME
Command Line Arguments
ssl-metrics-git-commits-loc-extract
-h
,--help
: Shows the help menu and exits-d
,--directory
: Directory where the.git
folder is located-b
,--branch
: Git branch to analyze-o
,--output
: Output analysis to JSON file
ssl-metrics-git-commits-loc-graph
-h
,--help
: Shows the help menu and exits-i
,--input
: The input data file that will be read to create the graphs-l
,--graph-loc-filename
: The filename to output the LOC graph to-d
,--graph-delta-loc-filename
: The filename to output the Delta LOC graph to-k
,--graph-k-loc-filename
: The filename to output the K LOC graph to-m
,--maximum-degree-polynomial
: Estimated maximum degree of polynomial-r
,--repository-name
: Name of the repository that is being analyzed--x-window-min
: The smallest x value that will be plotted--x-window-max
: The largest x value that will be plotted
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ssl-metrics-git-commits-loc-0.7.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d26a84ff29c1b5be681a791a07460fbd8ef1bd1fb53bfa59a87992d2e7f1f0c1 |
|
MD5 | e2912bc17deb7e3aee40630868bd73a1 |
|
BLAKE2b-256 | aa00207c32e6a8b9eb7a346d59f7034f52cf0a4a4b7a8355ef8e98411c5dd7f4 |
Hashes for ssl_metrics_git_commits_loc-0.7.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 727411836d0925c4f3e04bb7c7d23c5b40b5af07f0c503357e5ce8e11271d38e |
|
MD5 | e960d2d392f01bf1ab51d09dfed44e06 |
|
BLAKE2b-256 | 2bbeefe906b2facd631b677c6231692a2e754de09191401c2c6a62b28b37643c |