README.md

github_stats

Simple script to show the repositories info using the GitHub API

Install

1. Download file

   git clone https://github.com/elpop/github_stats.git
   

2. Perl Dependencies

   JSON

   LWP::UserAgent

   Config::Simple

   Getopt::Long

   All the Perl Modules are available via metacpan or install them via the "cpan" program in your system. Debian/Ubuntu and Fedora have packages for the required perl modules.

   for Fedora/Redhat:

   sudo dnf install perl-JSON perl-libwww-perl perl-LWP-Protocol-https perl-Config-Simple perl-Getopt-Long
   

   for Debian/Ubuntu:

   sudo apt-get install libjson-perl libwww-perl liblwp-protocol-https-perl libconfig-simple-perl
   sudo cpan -i Getopt::Long
   

   On Mac OS:

   To compile some Perl modules, you need to install the Xcode Command Line Tools:

   xcode-select --install
   

   Install with CPAN:

   sudo cpan -i JSON LWP::UserAgent LWP::Protocol::https Config::Simple Getopt::Long
   

3. Obtain your Github Token

   In order to work with the program, you must obtain a developer API access token from Github:

   Managing your personal access tokens

4. Copy and edit etc/github_stats.conf

   sudo cp etc/github_stats.conf /etc/.
   

   sudo vim etc/github_stats.conf
   

   Change the values according your user and Github Access Token:

   [github]
   user = 'YOUR_GITHUB_USER'
   token = 'YOUR_GITHUB_TOKEN'    
   

5. Put it on your search path

   Copy the github_stats.pl program somewhere in your search path:

   sudo cp github_stats.pl /usr/local/bin/.
   

Sponsor the project

Please sponsor this project, to pay my high debt on credit cards :)