githubpotentials

README

Github Potentials

Github Potentials command line tool is package that allows you to find rising Github repositories in 3 steps:

• Fetch recently updated repositories (up to 1k).
• Count stats for last n hours/days: new stars, unique contributors and commits.
• Sort by selected criteria and take the best.

Command line tool

Under cmd/ghp directory you can see an example of using this package.

go get github.com/artisresistance/githubpotentials/cmd/ghp

You must provide config file that contains your Github API secret token. Example output you can find here.

Documentation

Index

• type ErrorHandler
• type Potentials
  • func New(token string, since time.Time, log *log.Logger) Potentials
• type RepositoryChannel
  • func (in RepositoryChannel) Dump() RepositoryCollection
  • func (in RepositoryChannel) FilterZeroStats(criteria SortCriteria) RepositoryChannel
  • func (in RepositoryChannel) Split(count int) []RepositoryChannel
• type RepositoryCollection
  • func (c RepositoryCollection) Sort(criteria SortCriteria) RepositoryCollection
  • func (c RepositoryCollection) Trim(count int) RepositoryCollection
• type SortCriteria
  • func (sc SortCriteria) String() string

Types

type ErrorHandler

type ErrorHandler func(error)

ErrorHandler callback allows you to catch/log/report errors.

type Potentials

type Potentials interface {
	Search(int) RepositoryChannel
	CountStats(RepositoryChannel) RepositoryChannel
	APIRates() (remaining int, reset time.Time, err error)
}

Potentials is main worker of package.

func New

func New(token string, since time.Time, log *log.Logger) Potentials

New returns new instance of package. token - github api token.

type RepositoryChannel

type RepositoryChannel chan *github.Repository

func (RepositoryChannel) Dump

func (in RepositoryChannel) Dump() RepositoryCollection

func (RepositoryChannel) FilterZeroStats

func (in RepositoryChannel) FilterZeroStats(criteria SortCriteria) RepositoryChannel

func (RepositoryChannel) Split

func (in RepositoryChannel) Split(count int) []RepositoryChannel

type RepositoryCollection

type RepositoryCollection []github.Repository

func (RepositoryCollection) Sort

func (c RepositoryCollection) Sort(criteria SortCriteria) RepositoryCollection

func (RepositoryCollection) Trim

func (c RepositoryCollection) Trim(count int) RepositoryCollection

type SortCriteria

type SortCriteria int

SortCriteria enum defines all available criteria of generating result.

const (
	CommitsCriteria SortCriteria = iota
	StarsCriteria
	ContributorsCriteria
	CombinedCriteria
	NoCriteria
)

All available sort criteria.

func (SortCriteria) String

func (sc SortCriteria) String() string