Metadata-Version: 2.1
Name: clime-productivity
Version: 0.4
Summary: CLIME - Productivity
Home-page: https://ssl.cs.luc.edu/projects/metricsDashboard
Author: Software and Systems Laboratory - Loyola University Chicago
Author-email: ssl-metrics@ssl.luc.edu
License: BSD
Project-URL: Bug Tracker, https://github.com/SoftwareSystemsLaboratory/clime-productivity/issues
Project-URL: GitHub Repository, https://github.com/SoftwareSystemsLaboratory/clime-productivity
Keywords: bugzilla,bus factor,bus factor,cloc,commits,commits,delta lines of code,engineering,git,git,github,github,gitlab,installable,issue density,issue density,issue spoilage,issues,issues,kloc,lines of code,longitudinal graphs,loyola university chicago,loyola,luc,metrics,metrics,mining,productivity,python,repository mining,repository,simple,sloccount,software engineering,software metrics,software systems laboratory,software,ssl,thousands of lines of code,tool,vcs
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# CLIME Productivity

> A tool to calculate the productivity of a Git repository

## Table of Contents

- [CLIME Productivity](#clime-productivity)
  - [Table of Contents](#table-of-contents)
  - [About](#about)
    - [Licensing](#licensing)
  - [How To Use](#how-to-use)
    - [Installation](#installation)
    - [Shell Commands](#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](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`

``` shell
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
```

`clime-productivity-graph -h`

``` shell
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
```


