github-contributions-counter
Advanced tools
A simple Javascript API that will return the public github contributions history for a user based on a universal function
A simple Javascript API that will return the public Github contributions history for a user based on a universal function
This is a simple REST API wrapper around GitHubs API/V4 contributions graphQL api. Prior to the implementation of the V4 api this package scraped contribution data from GitHub profiles.
Via npm
npm i github-contributions-counter
Via yarn
yarn add github-contributions-counter
import { getGithubContributions } from 'github-contributions-counter'
getGithubContributions({
username: 'github_username',
token: 'github_token' // secret
}).then((r) => {
console.log(r)
})
| Parameter | Description | Status | Type |
|---|---|---|---|
username | A valid GitHub username. Organization names are not currently supported | Required | string |
token | A valid GitHub PAT with read:usr permissions. You can find instructions on how to generate a PAT here. | Required | string |
Contributions are welcomed and encouraged! Refer to Contribution Guidelines
git clone git@github.com:SammyRobensParadise/github-contributions-counter.git
npm install
# or
yarn install
Develop 💻
Build using rollup.js
npm run build
# or
yarn run build
Author: Sammy Robens-Paradise. sammy.world
FAQs
A simple Javascript API that will return the public github contributions history for a user based on a universal function
The npm package github-contributions-counter receives a total of 79 weekly downloads. As such, github-contributions-counter popularity was classified as not popular.
We found that github-contributions-counter demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
Security News
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.