github

package

v0.0.0-...-9c02efb Latest Latest Go to latest Published: Jan 12, 2021 License: GPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type GitHubCrawler struct {
	API_KEY string
	// contains filtered or unexported fields
}

GitHubCrawler Contains API_KEY and Client for API calls

func NewCrawler(apiKey string) *GitHubCrawler

NewCrawler Constructs a new GitHubCrawler given an API_KEY

func (c *GitHubCrawler) GetFollowers(user string) (users []entities.User, err error)

GetFollowers Fetches a list of Users following given user

func (c *GitHubCrawler) GetOrgMembers(org string) (users []entities.User, err error)

GetOrgMembers Fetches a list of Users belonging to a given Organization string

func (c *GitHubCrawler) GetRepoContributors(user, repo string) (users []entities.User, err error)

GetRepoContributors Fetches a list of Users contributing to a given repository belonging to a given username

func (c *GitHubCrawler) GetUserRepositories(user string) (repos []entities.Repository, err error)

GetUserRepositories Fetches a List of Repositories from a given Username

func (c *GitHubCrawler) SearchCode(q string, resp chan entities.SearchResult)

SearchCode Searches for code String in all of GitHub and streams a channel of SearchResults