Project Health

Library for calculating project health report and analysis based on GitHub Activity data

Installation

Add this line to your application's Gemfile:

gem 'project-health'

And then execute:

bundle

Or install it yourself as:

gem install project-health

Usage

From command line:

Set GitHub username/password to increase API rates

export GITHUB_USERNAME=username
export GITHUB_PASSWORD=password

project-health capistrano/capistrano

Result

Showing project health for capistrano/capistrano

Basic
┌─────────────┬─────────────────────────────────────┐
│ Name        ╎ capistrano/capistrano               │
│ Description ╎ Remote multi-server automation tool │
│ Created     ╎ 2009-02-26T16:14:04Z                │
│ Last push   ╎ 2012-11-09T07:48:26Z                │
│ Language    ╎ Ruby                                │
│ Stars       ╎ 2883                                │
└─────────────┴─────────────────────────────────────┘

Pull Requests
┌────────────────────────────────┬────────┐
│ All                            ╎ 151    │
│ Open                           ╎ 17     │
│ Closed                         ╎ 134    │
│ Open %                         ╎ 11.26  │
│ Closed %                       ╎ 88.74  │
│ Open/Closed % ratio            ╎ 0.13   │
│ Open time in days              ╎ 951    │
│ Min open time in days          ╎ 0      │
│ Max open time in days          ╎ 402    │
│ Average days request is opened ╎ 55     │
│ Health                         ╎ Normal │
└────────────────────────────────┴────────┘

Issues
┌──────────────────────────────┬───────┐
│ All                          ╎ 315   │
│ Open                         ╎ 54    │
│ Closed                       ╎ 261   │
│ Open %                       ╎ 17.14 │
│ Closed %                     ╎ 82.86 │
│ Open/Closed % ratio          ╎ 0.21  │
│ Open time in days            ╎ 6852  │
│ Min open time in days        ╎ 0     │
│ Max open time in days        ╎ 495   │
│ Average days issue is opened ╎ 126   │
│ Health                       ╎ Bad   │
└──────────────────────────────┴───────┘

From code:

require 'pp'
require 'project-health'

# Set GitHub username/password to increase API rates
ProjectHealth.configure do |c|
  #c.login = ''  # use your github name
  #c.password = '' # use your github password
end

project = ProjectHealth.new('capistrano/capistrano')

pp project.stats