README
¶
Scrape
Overview
Scrape is a simple CLI tool to help Gather data from github repos about contributions
Getting Started
If you have a working Go enviroment on your computer, you can download it by running:
go get -u github.com/dmmcquay/scrape
Usage
GitHub access token
Scrape requires a GitHub access token before it can be used. See
Github Documentation for further information on how to get one. After you
have the token, please set the env variable SCRAPE_TOKEN to the access token.
scrape apirates
Org and Repo
The following commands all require an org and Repo to be specified. An example
would be for this repository where Org is dmmcquay and Repo is scrape. The format
for this would be dmmcquay/scrape
scrape top100
running:
scrape top100 foo/bar
will return a list of the top 100 contributors to repository.
scrape commits
running:
scrape commits foo/bar
will return a list of all contributors and a total count of commits for specified repository.
scrape openprs
running:
scrape openprs foo/bar
will return a list of all contributors and a total count of open PRs they have for the specified repository.
scrape closedprs
running:
scrape closedprs foo/bar
will return a list of all contributors and a total count of closed PRs they have for the specified repository.
Documentation
¶
Overview ¶
Package scrape implements functions to get information from github organizations and repositories
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetAllCommits ¶
GetAllCommits prints to stdout a sorted list of all commits to a specified organization's repository
func GetPRs ¶
GetPRs prints to stdout a sorted list of either closed or open PRs to specified organization's repository
Types ¶
This section is empty.
Source Files
Directories