Metadata-Version: 2.1
Name: codemetrics-report
Version: 0.1.0
Summary: Quick reporting of codemetrics minings
Home-page: https://github.com/lpereira95/codemetrics-report
Author: L. F. Pereira
Author-email: luisfgpereira95@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/lpereira95/codemetrics-report/issues
Keywords: code metrics,code analysis,scm,git
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: codemetrics
Requires-Dist: altair
Requires-Dist: tqdm
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: click

`codemetrics-report` builds on top of [`codemetrics`](https://pypi.org/project/codemetrics/) to quickly generate an `html` report of a repo.


The generated `html` report contains interactive graphs with:

* lines of code for each programming language
* age of files and recent development activity
* lines of code and file age
* hotspots


Check out this [blog post](https://cerfacs.fr/coop/codemetrics) for a hands-on introduction to `codemetrics`. Most of the code in which the report relies on is based on this [notebook](https://github.com/elmotec/codemetrics/blob/master/notebooks/pandas.ipynb).


Many thanks to Eloi Démolis for the development of the main methods present in the `html` template and Jérôme Lecomte for the development of `codemetrics`.


## Usage

The following command creates an `html` file in your current working directory (simply open it with your favorite web browser):

```bash
generate-codemetrics-report <repo_location>
```


## Installation

```bash
pip install codemetrics-report
```

