ibonly/github-status-evangelists

A package that grade a github user based on the user's contribution on open source project.

dev-master 2015-10-08 11:11 UTC

Requires

• php: >=5.5
• guzzlehttp/guzzle: 4.0
• vlucas/phpdotenv: ^2.0

Requires (Dev)

• phpunit/phpunit: 4.8.*

MIT

• Adeniyi Ibraheem

README

This Package analyzes the contributions of a Github users based on the number of repositories a user has. It also ranks the user based on the author's perspective on the number of repositories individual user has. The ranking is shown bellow:

Number of Repository < 5 - Zero Evanglist

5 <= Number of Repository <= 10 - Junior Evanglist

11 <= Number of Repository <= 20 - Associate Evanglist

Number of Repository >= 21 - Senior Evanglist

Installation

PHP 5.5+ and Composer are required.

Via Composer

$ composer require ibonly/github-status-evangelists

$ composer install

Usage 1

use Ibonly\GithubStatusEvangelist\EvangelistStatus;

$status = new EvangelistStatus($username);

Note that $username is the GitHub username of the individual.

$status->getStatus();

Usage 2

To catch if the username entered is not a github user

use Ibonly\GithubStatusEvangelist\EvangelistStatus;
use Ibonly\GithubStatusEvangelist\NullUserException;

Note that $username is the GitHub username of the individual.

try {
    $status = new EvangelistStatus($username);
} catch (NullUserException $e){
    echo $e->errorMessage();
}

$status->getStatus();

Testing

$ vendor/bin/phpunit test

Contributing

To contribute and extend the scope of this package, Please check out CONTRIBUTING file for detailed contribution guidelines.

Credits

Open-source-Evangelist is created and maintained by Ibraheem ADENIYI.