mximp / repo-stats

Simple statistics on file repository

Repository statistics

Collects various repository statistics such as files count by type or lines of code.

Installation

Just clone this repo:

git clone https://github.com/mximp/repo-stats.git

Usage

As Python module:

python -m stats -i ".java" -i ".py" /path/to/repo/  

Output example:

Repo: /path/to/repo
Inclusions spec: ('.java',)
Exclusions spec: ()
Files total: 63
Extensions excluded: {'', '.properties', '.md', '.xml', '.class', '.pack', '.jar', '.yml', '.sample', '.lst', '.iml', '.idx'}
Files matched: 2
Files excluded: 61
LoC total: 89
LoC avg: 44.5
LoC max: 82
Classes: 13
Extensions (LoC/max/avg): {'.java': (89, 82, 44.5)}

Stats

The following statistics is being collected:

• Files total: total number of files found in the repo
• Files matched: number of files which matched provided criteria, i.e. inclusion/exclusion spec
• LoC total: total lines within matched files
• LoC avg: average number of lines per file across all matched files
• LoC max: maximum number of lines in a file acrosss all matched files
• Classes: number of classes found in matched files (.java and .py supported)
• Extensions: total, max, and average LoC per file extension.

repo-stats's Issues

Add count of only matched files

Currently the report prints only overall files count.
It would be good to see also total number of files which matched inclusion/exclusion filters.

Print out excluded extensions

Print extensions that were found in repo but excluded from stat.

Add average/maximum LoCs

It would be good to calculate average and maximum LoCs.
Need to be calculated total and per file type.

Wrap `stat` command by CLI

The module is now run as script with all args hardcoded.
Make it proper CLI interface.

Call example:

python -m stats /path/to/repo -i ".java .py" -e ".xml"

Click can be used for arg parsing.

Add pylint

Count files and lines of code

For given folder we want to calculate a number of files (recursively) as well as LoC per file extension.
The result is to be printed into console