https://github.com/arsamsarabi/gh-calendar-scraper

Scrapes a users GitHub contributions calendar
https://github.com/arsamsarabi/gh-calendar-scraper

Last synced: about 1 month ago
JSON representation

Scrapes a users GitHub contributions calendar

• Host: GitHub
• URL: https://github.com/arsamsarabi/gh-calendar-scraper
• Owner: arsamsarabi
• License: mit
• Created: 2022-08-14T13:58:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-15T17:35:17.000Z (over 2 years ago)
• Last Synced: 2024-12-13T23:08:12.296Z (2 months ago)
• Language: TypeScript
• Size: 106 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gh-calendar-scraper

Scrapes a users GitHub contributions calendar

![Github calendar example](/assets/calendar-example.png)

## Install

Install the package in your project.

```sh

$ yarn add gh-calendar-scraper

```

## Usage

Import the "fetchGithubCalendar" function and pass in a GitHub username.

```ts

import { GithubCalendar, fetchGithubCalendar } from 'gh-calendar-scraper'

const calendar: GithubCalendar = await fetchGithubCalendar('username')

```

## Types

Thit package also exports the following Typescript types:

```ts

type DayStats = {

  x: number

  y: number

  rx: number

  ry: number

  count: number

  date: string

  level: number

}

type GithubCalendar = Array

```