awesome_tool

README

awesome-tool

awesome-tool is a command-line tool to retrieve the stars of all repos in an awesome-list (such as awesome-go.

Installation

Release

Download the latest release at GitHub Releases Page, please.

Homebrew (macOS)

brew install hedzr/brew/awesome-tool

# Or:
brew tap hedzr/brew
brew install awesome-tool

Usage

awesome-tool build one \
    --name=awesome-go \
    --source=https://github.com/avelino/awesome-go \
    --work-dir=./output

# The results is stored in:
ls -la ./output/aweesome-go/
# open ./output/aweesome-go/output.md  # open it in default browser, such as chrome, ...

Result

The main result is a markdown file output/awesome-xxx/output.md, its preview looks like:

Github name and passwd

As running awesome-tool, it'll ask for your github account name and password to authorize an access token for Github API. The name and password will be destroy after the token got. But your token will be saved into $HOME/.asg.stats.token for the next time, you could always erase the file safely.

The access token is used to request Github API v3 and v4.

Contributors is 0 now

We can't query how many contributors via GitHub API v4, currently.

For saving your querying bandwidth, we ignore this count.

LICENSE

MIT / Apache 2.0

Documentation

Index

• Constants

Constants

const (
	// AppName const
	AppName = "awesome-tool" // main app-name
	// Version const
	Version = "1.2.1" // version name
	// VersionInt const
	VersionInt = 0x010201 // using as
)