search

theDavidBarton / github-streak

Parses the Contribution graph to count the current streak of a GitHub user.
https://www.npmjs.com/package/github-streak-scraper
MIT License
0 stars 0 forks source link
github-contributions puppeteer streak

readme

GitHub Streak Scraper

npm package Dependency Status

Parses the Contribution graph to count the current streak of a GitHub user.

Usage

Wrap githubStreakScraper('GitHub-user-name') in an async function/promise.

const getStreakData = async => {
  const githubStreak = await githubStreakScraper('theDavidBarton');
  console.log(githubStreak);
}
{
  user: 'theDavidBarton',
  currentlyOnStreak: true,
  currentStreakCount: 18,
  currentStreakStartDate: '2019-12-30'
}

License

MIT License

Copyright (c) 2020 David Barton