octostats

KO | EN

gitlite — search

#javascript #python #llm #golang #go #android #machine-learning #linux #docker #nodejs #awesome #kubernetes #openai #open-source

(★ 16)

🐙🐱📦 Additional GitHub API methods

octostats Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# octostats 🐙🐱📦

[![Go Reference](https://pkg.go.dev/badge/github.com/irevenko/octostats.svg)](https://pkg.go.dev/github.com/irevenko/octostats)

> A supplementary Go package on top of <a href="https://github.com/google/go-github">go-github</a> and <a href="https://github.com/shurcooL/githubv4">githubv4</a>

GitHub API Superstructure

# Installation 🔨
```go get github.com/google/go-github``` 
```go get github.com/google/go-querystring``` 
```go get github.com/shurcooL/githubv4``` 
```go get golang.org/x/oauth2```

```go get github.com/irevenko/octostats```

# Methods 🧰
* [REST](#REST "Goto #REST")
	* [AllRepos](#AllRepos "Goto ##AllRepos")
	* [LanguagesByRepo](#LanguagesByRepo "Goto ##LanguagesByRepo")
	* [MostUsedLicenses](#MostUsedLicenses "Goto ##MostUsedLicenses")
	* [MostStarredRepos](#MostStarredRepos "Goto ##MostStarredRepos")
	* [MostForkedRepos](#MostForkedRepos "Goto ##MostForkedRepos")
	* [StarsPerLanguage](#StarsPerLanguage "Goto ##StarsPerLanguage")
	* [ForksPerLanguage](#AllRepos "Goto ##ForksPerLanguage")
	* [TotalStars](#TotalStars "Goto ##TotalStars")
	* [TotalForks](#TotalForks "Goto ##TotalForks")
* [GraphQL](#GraphQL "Goto #GraphQL")
	* [LanguagesByCommit](#LanguagesByCommit "Goto ##LanguagesByCommit")
	* [AllContributions](#AllContributions "Goto ##AllContributions")
	* [AllCommits](#AllCommits "Goto ##AllCommits")
	* [AllIssues](#AllIssues "Goto ##AllIssues")
	* [AllPullRequests](#AllPullRequests "Goto ##AllPullRequests")
	* [YearActivity](#YearActivity "Goto ##YearActivity")
	* [UserDetails](#UserDetails "Goto ##UserDetails")
	* [OrganizationDetails](#OrganizationDetails "Goto ##OrganizationDetails")

# Docs 📋
Go Reference: https://pkg.go.dev/github.com/irevenko/octostats
# REST
All examples are using ```AuthREST``` 
```ctx, client := r.AuthREST("<YOUR_TOKEN>")```

If you want you can write your own auth but keep in mind that you in order to use this package ```client, context``` are required

## AllRepos
Returns slice of repos for user/organization (https://api.github.com/users/USERNAME/repos)
```go
import ( 
    "fmt"
    "log"

"github.com/google/go-github/github"
    r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")

allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}
	fmt.Println(allRepos)
}
```

## LanguagesByRepo
Returns two slices of names and occurrences
```go
import ( 
    "fmt"
    "log"
    "strconv"

"github.com/google/go-github/github"
    r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")

allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}

usedLangs, langsNum := r.LanguagesByRepo(client, allRepos)
	fmt.Println("Languages By Repo")
	for i, v := range usedLangs {
		fmt.Println(v + ": " + strconv.Itoa(langsNum[i]))
	}
}
```

## MostUsedLicenses
Returns two slices of names and occurrences
``` go
import ( 
	"fmt"
	"log"
	"strconv"

"github.com/google/go-github/github"
	r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")

allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}

usedLicenses, licsNum := r.MostUsedLicenses(client, allRepos)
	fmt.Println("Most used licenses")
	for i, v := range usedLicenses {
		fmt.Println(v + ": " + strconv.Itoa(licsNum[i]))
	}
}
```

## MostStarredRepos
Returns two slices of names and stars num
``` go
import ( 
	"fmt"
	"log"
	"strconv"

"github.com/google/go-github/github"
	r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")
	
	allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}
 
	starredRepos, starredNums := r.MostStarredRepos(client, allRepos)
	fmt.Println("Most starred repos")
	for i, v := range starredRepos {
		fmt.Println(v + ": " + strconv.Itoa(starredNums[i]))
	}
}
```

## MostForkedRepos
Returns two slices of names and forks num
```go
import ( 
	"fmt"
	"log"
	"strconv"

"github.com/google/go-github/github"
	r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")

allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}
 
	forkedRepos, forkedNums := r.MostForkedRepos(client, allRepos)
	fmt.Println("Most forked repos")
	for i, v := range forkedRepos {
		fmt.Println(v + ": " + strconv.Itoa(forkedNums[i]))
	}
}
```

## StarsPerLanguage
Returns two slices of languages and stars num
```go
import ( 
	"fmt"
	"log"
	"strconv"

"github.com/google/go-github/github"
	r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")

allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}
 
	starsPerL, starsNum := r.StarsPerLanguage(client, allRepos)
	fmt.Println("Stars per lang")
	for i, v := range starsPerL {
		fmt.Println(v + ": " + strconv.Itoa(starsNum[i]))
	}
}
```
## ForksPerLanguage
Returns two slices of languages and forks num
```go
import ( 
 	"fmt"
	"log"
	"strconv"

"github.com/google/go-github/github"
	r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")

allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}

forksPerL, forksNum := r.ForksPerLanguage(client, allRepos)
	fmt.Println("Forks per lang")
	for i, v := range forksPerL {
		fmt.Println(v + ": " + strconv.Itoa(forksNum[i]))
	}
}
```

## TotalStars
Returns integer number
```go
import ( 
	"fmt"
	"log"

"github.com/google/go-github/github"
	r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")

allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}
 
	totalStars := r.TotalStars(client, allRepos)
	fmt.Println("Total stars")
	fmt.Println(totalStars)
}
```

## TotalForks
Returns integer number
```go
import ( 
	"fmt"
	"log"

"github.com/google/go-github/github"
	r "github.com/irevenko/octostats/rest"
)

func main() {
	ctx, client := r.AuthREST("<YOUR_TOKEN>")
	
	allRepos, err := r.AllRepos(ctx, client, "<USER_OR_ORGANIZATION>")
	if err != nil {
	 log.Fatal(err)
	}
 
	totalForks := r.TotalForks(client, allRepos)
	fmt.Println("Total forks")
	fmt.Println(totalForks)
}
```

# GraphQL
All examples are using ```AuthGraphQL``` 
```client := g.AuthGraphQL("<YOUR_TOKEN>")```

If you want you can write your own auth but keep in mind that you in order to use this package ```client``` is required

## LanguagesByCommit
Returns two slices of languages and commits 
```from``` and ```to``` must be within 1 year span (2009, 2010 OR 2014, 2015 etc...)
```go
import ( 
	"fmt"
	"log"