go-github

go-github is a Go client library for accessing the GitHub API.

Documentation:
Mailing List: go-github@googlegroups.com
Build Status:
Test Coverage: (gocov report)

go-github requires Go version 1.1 or greater.

Usage

import "github.com/google/go-github/github"

Construct a new GitHub client, then use the various services on the client to access different parts of the GitHub API. For example, to list all organizations for user "willnorris":

client := github.NewClient(nil)
orgs, _, err := client.Organizations.List("willnorris", nil)

Some API methods have optional parameters that can be passed. For example, to list repositories for the "github" organization, sorted by the time they were last updated:

client := github.NewClient(nil)
opt := &github.RepositoryListByOrgOptions{Sort: "updated"}
repos, _, err := client.Repositories.ListByOrg("github", opt)

Authentication

The go-github library does not directly handle authentication. Instead, when creating a new client, pass an http.Client that can handle authentication for you. The easiest and recommended way to do this is using the goauth2 library, but you can always use any other library that provides an http.Client. If you have an OAuth2 access token (for example, a personal API token), you can use it with the goauth2 using:

t := &oauth.Transport{
  Token: &oauth.Token{AccessToken: "... your access token ..."},
}

client := github.NewClient(t.Client())

// list all repositories for the authenticated user
repos, _, err := client.Repositories.List("", nil)

See the goauth2 docs for complete instructions on using that library.

Pagination

All requests for resource collections (repos, pull requests, issues, etc) support pagination. Pagination options are described in the github.ListOptions struct and passed to the list methods directly or as an embedded type of a more specific list options struct (for example github.PullRequestListOptions). Pages information is available via github.Response struct.

client := github.NewClient(nil)
opt := &github.RepositoryListByOrgOptions{
  Type: "public",
  ListOptions: github.ListOptions{PerPage: 10, Page: 2},
}
repos, resp, err := client.Repositories.ListByOrg("github", opt)
fmt.Println(resp.NextPage) // outputs 3

For complete usage of go-github, see the full package docs.

Roadmap

This library is being initially developed for an internal application at Google, so API methods will likely be implemented in the order that they are needed by that application. You can track the status of implementation in this Google spreadsheet. Eventually, I would like to cover the entire GitHub API, so contributions are of course always welcome. The calling pattern is pretty well established, so adding new methods is relatively straightforward.

License

This library is distributed under the BSD-style license found in the LICENSE file.