# github-streak-scraper

> A scraper which returns your current GitHub streak.

Latest version **2.0.0** (published 2021-02-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-streak-scraper
pnpm add github-streak-scraper
yarn add github-streak-scraper
bun add github-streak-scraper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-02-05 |
| First published | 2020-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.18.1 |
| Dependencies | 2 |
| Unpacked size | 69.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | David Barton |
| Maintainers | thedavidbarton |

## Links

- npm: https://www.npmjs.com/package/github-streak-scraper
- Repository: https://github.com/theDavidBarton/github-streak
- npm.io page: https://npm.io/package/github-streak-scraper

## Dependencies (2)

- [puppeteer](https://npm.io/package/puppeteer.md) ^3.0.2
- [svg-parser](https://npm.io/package/svg-parser.md) ^2.0.3

## Recent versions

- 2.0.0 (latest) — 2021-02-05
- 1.0.3 — 2020-09-03
- 1.0.2 — 2020-05-01
- 1.0.1 — 2020-01-17
- 1.0.0 — 2020-01-17

## README

# GitHub Streak Scraper

[![npm package](https://img.shields.io/npm/v/github-streak-scraper.svg)](https://www.npmjs.com/package/github-streak-scraper)
[![Dependency Status](https://david-dm.org/theDavidBarton/github-streak.svg)](https://david-dm.org/theDavidBarton/github-streak/)

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

## Usage

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

```js
const getStreakData = async => {
  const githubStreak = await githubStreakScraper('theDavidBarton');
  console.log(githubStreak)
}
```

```js
{
  user: 'theDavidBarton',
  currentlyOnStreak: true,
  currentStreakCount: 18,
  currentStreakStartDate: '2019-12-30'
}
```

## License

MIT License

Copyright (c) 2020 David Barton

---
_Source: https://npm.io/package/github-streak-scraper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._