Comment Report

Open-Source project to promote good commenting behavior by showing the ratio of comments to executable code in a public repository.

Getting Started

After downloading all packages, simple run:

python main.py -i ~/samples/directory/path/name

• or with a github repository link (HTTPS)

python main.py -g ~/samples/directory/path/name.git

Prerequisites

• Python - Python 2.x or higher required

Installing

There are two additional libraries: Tabulate and Plotly API

pip install plotly
pip install tabulate

Built With

• Tabulate - Pretty CLI Output
• Plotly API - Data Visualization

License

This project is licensed under the MIT License - see the LICENSE.md file for details