Skip to main content

Quick reporting of codemetrics minings

Project description

codemetrics-report builds on top of 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 for a hands-on introduction to codemetrics. Most of the code in which the report relies on is based on this notebook.

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):

generate-codemetrics-report <repo_location>

Installation

pip install codemetrics-report

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codemetrics-report-0.1.1.tar.gz (7.7 kB view hashes)

Uploaded Source

Built Distribution

codemetrics_report-0.1.1-py3-none-any.whl (8.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page