Skip to content

elquimista/github-contrib-stats

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

github-contrib-stats

Retrieve GitHub total contribution count and streaks.

Prerequisites

This requires Node.js v7.7.0 or greater.

Installation

npm install --save github-contrib-stats

Usage

const getGhContribStats = require(‘github-contrib-stats’);

async function test() {
  try {
    const stats = await getGhContribStats('clthck');
    console.log(stats);
  } catch (err) {
    console.error(err, err.stack);
  }
}

test();

Output will be in the following format:

{
  basicUserData: { ... }, // Find more details at https://api.github.com/users/clthck
  contributionStats: {
    totalContributions: 857,
    todaysContributions: 9,
    currentStreak: 4,
    longestStreak: 24
  }
}

About

Retrieve GitHub total contribution count and streaks

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published