GitHub-Commits
Framework to get users and organization commit stats from github
Purpose
A simple framework to get users and organization commit stats from github. Can filter stats by a date range. Can be used to integrate, git stats into a dashboard.
Inspired by one of Fred George's talk on Programmer Anarchy, in which his team has a dashboard indicating commits for a week.
Install
npm install github-commits
Examples
Get Current Week GitHub repository commits for a user
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Current Week Commits for a user
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Open Issues for a user for current week commits
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Get Commits for a user Until/Up to a Certain Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Commits for a user Until/Up to a Certain Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Open Issues for a user Until/Upa Certain Commit Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Get Commits for a user Since a Certain Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Commits for a user Since a Certain Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Open Issues for a user Since a Certain Commit Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Get Commits for a user between a Set of Dates
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Commits for a user between a Set of Dates
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Open Issues for a user between a Set of Commit Dates
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Get Current Week GitHub repository commits for an org
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Current Week Commits for an org
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Open Issues for an org for current week commits
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Get Commits for an org Until/Up to a Certain Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Commits for an org Until/Up to a Certain Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Open Issues for an org Until/Upa Certain Commit Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Get Commits for an org Since a Certain Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Commits for an org Since a Certain Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Open Issues for an org Since a Certain Commit Date
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Get Commits for an org between a Set of Dates
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Commits for an org between a Set of Dates
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Sum Open Issues for an org between a Set of Commit Dates
var GitHubCommits = ;var gitHubCommits = ; gitHubCommits ;
Specify an authorization key to connect with GitHub
var GitHubCommits = ;//Can specify the GitHub api authorization key for the private or enterprise instancevar gitHubCommits = "<SOME_GITHUB_AUTHORIZATION_KEY>";
Specify an authorization key and Specific GitHub url to connect with
var GitHubCommits = ; var gitHubUrl = "https://api.github.com";var apiAuthorizationKey = "<SOME_GITHUB_AUTHORIZATION_KEY>"; //Can specify the GitHub api authorization key for the private or enterprise instancevar gitHubCommits = apiAuthorizationKeygitHubUrl;
Specify an enterprise or private GitHub instance
var gitHubCommits = ; //Can specify the GitHub api authorization key for the private or enterprise instancevar enterpriseGitHubUrl = "https://<ENTERPISE_GITHUB_URL>";var apiAuthorizationKey = "<SOME_GITHUB_AUTHORIZATION_KEY>"; var gitHubCommits = apiAuthorizationKeyenterpriseGitHubUrl;
Other Examples
For additional examples see the tests. To run them:
npm test
Credits/Other Frameworks
API Limits
Github limits unauthorized requests to 60 per hour. If you exceed the limit an error will be thrown. An authorization key can be easily obtained as sepecified below, and easily used in the api
var GitHubCommits = ; var gitHubUrl = "https://api.github.com";var apiAuthorizationKey = "<SOME_GITHUB_AUTHORIZATION_KEY>"; //Can specify the GitHub api authorization key for the private or enterprise instancevar gitHubCommits = apiAuthorizationKeygitHubUrl;
How To Get An Authorization Code With Curl
curl -d '{"scopes":["repo"],"note":"Help example"}' https://api.github.com/authorizations