From 53a129e94c68b31961bbf36447c0e1b250377f41 Mon Sep 17 00:00:00 2001 From: Glenn Lewis Date: Sat, 9 Jul 2016 22:13:44 -0700 Subject: [PATCH] Sync doc.go and README.md Fixes #397. Change-Id: I30ce336e3a36cf5758b9bf52b9dd77f7c1df5f27 --- README.md | 114 ++++++++++++++++++++++++++++++++++++++++++-------- github/doc.go | 40 +++++++++++------- 2 files changed, 122 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 333b4de..9a3a7dc 100644 --- a/README.md +++ b/README.md @@ -16,33 +16,41 @@ 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": +access different parts of the GitHub API. For example: ```go client := github.NewClient(nil) + +// list all organizations for user "willnorris" orgs, _, err := client.Organizations.List("willnorris", nil) ``` -Some API methods have optional parameters that can be passed. For example, -to list public repositories for the "github" organization: +Some API methods have optional parameters that can be passed. For example: ```go client := github.NewClient(nil) -opt := &github.RepositoryListByOrgOptions{Type: "public"} + +// list recently updated repositories for org "github" +opt := &github.RepositoryListByOrgOptions{Sort: "updated"} repos, _, err := client.Repositories.ListByOrg("github", opt) ``` +The services of a client divide the API into logical chunks and correspond to +the structure of the GitHub API documentation at +http://developer.github.com/v3/. + ### Authentication ### -The go-github library does not directly handle authentication. Instead, when +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 [oauth2][] +you. The easiest and recommended way to do this is using the [oauth2][] 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 oauth2 using: +`http.Client`. If you have an OAuth2 access token (for example, a [personal +API token][]), you can use it with the oauth2 library using: ```go +import "golang.org/x/oauth2" + func main() { ts := oauth2.StaticTokenSource( &oauth2.Token{AccessToken: "... your access token ..."}, @@ -56,28 +64,98 @@ func main() { } ``` +Note that when using an authenticated Client, all calls made by the client will +include the specified OAuth token. Therefore, authenticated clients should +almost never be shared between different users. + See the [oauth2 docs][] for complete instructions on using that library. For API methods that require HTTP Basic Authentication, use the [`BasicAuthTransport`](https://godoc.org/github.com/google/go-github/github#BasicAuthTransport). +### Rate Limiting ### + +GitHub imposes a rate limit on all API clients. Unauthenticated clients are +limited to 60 requests per hour, while authenticated clients can make up to +5,000 requests per hour. To receive the higher rate limit when making calls +that are not issued on behalf of a user, use the +`UnauthenticatedRateLimitedTransport`. + +The `Rate` method on a client returns the rate limit information based on the most +recent API call. This is updated on every call, but may be out of date if it's +been some time since the last API call and other clients have made subsequent +requests since then. You can always call `RateLimits()` directly to get the most +up-to-date rate limit data for the client. + +To detect an API rate limit error, you can check if its type is `*github.RateLimitError`: + +```go +repos, _, err := client.Repositories.List("", nil) +if _, ok := err.(*github.RateLimitError); ok { + log.Println("hit rate limit") +} +``` + +Learn more about GitHub rate limiting at +http://developer.github.com/v3/#rate-limiting. + +### Conditional Requests ### + +The GitHub API has good support for conditional requests which will help +prevent you from burning through your rate limit, as well as help speed up your +application. `go-github` does not handle conditional requests directly, but is +instead designed to work with a caching `http.Transport`. We recommend using +https://github.com/gregjones/httpcache for that. + +Learn more about GitHub conditional requests at +https://developer.github.com/v3/#conditional-requests. + +### Creating and Updating Resources ### + +All structs for GitHub resources use pointer values for all non-repeated fields. +This allows distinguishing between unset fields and those set to a zero-value. +Helper functions have been provided to easily create these pointers for string, +bool, and int values. For example: + +```go +// create a new private repository named "foo" +repo := &github.Repository{ + Name: github.String("foo"), + Private: github.Bool(true), +} +client.Repositories.Create("", repo) +``` + +Users who have worked with protocol buffers should find this pattern familiar. + ### Pagination ### -All requests for resource collections (repos, pull requests, issues, etc) +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.PullRequestListOptions`). Pages information is available via the `github.Response` struct. ```go client := github.NewClient(nil) + opt := &github.RepositoryListByOrgOptions{ - Type: "public", - ListOptions: github.ListOptions{PerPage: 10, Page: 2}, + ListOptions: github.ListOptions{PerPage: 10}, +} +// get all pages of results +var allRepos []*github.Repository +for { + repos, resp, err := client.Repositories.ListByOrg("github", opt) + if err != nil { + return err + } + allRepos = append(allRepos, repos...) + if resp.NextPage == 0 { + break + } + opt.ListOptions.Page = resp.NextPage } -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][]. @@ -95,9 +173,9 @@ You can run integration tests from the `tests` directory. See the integration te 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][roadmap]. Eventually, I would like to cover the entire -GitHub API, so contributions are of course [always welcome][contributing]. The +needed by that application. You can track the status of implementation in +[this Google spreadsheet][roadmap]. Eventually, I would like to cover the entire +GitHub API, so contributions are of course [always welcome][contributing]. The calling pattern is pretty well established, so adding new methods is relatively straightforward. diff --git a/github/doc.go b/github/doc.go index 6c6f53a..ba7b089 100644 --- a/github/doc.go +++ b/github/doc.go @@ -6,6 +6,10 @@ /* Package github provides a client for using the GitHub API. +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: @@ -14,7 +18,9 @@ access different parts of the GitHub API. For example: // list all organizations for user "willnorris" orgs, _, err := client.Organizations.List("willnorris", nil) -Set optional parameters for an API method by passing an Options object. +Some API methods have optional parameters that can be passed. For example: + + client := github.NewClient(nil) // list recently updated repositories for org "github" opt := &github.RepositoryListByOrgOptions{Sort: "updated"} @@ -51,18 +57,23 @@ Note that when using an authenticated Client, all calls made by the client will include the specified OAuth token. Therefore, authenticated clients should almost never be shared between different users. +See the oauth2 docs for complete instructions on using that library. + +For API methods that require HTTP Basic Authentication, use the +BasicAuthTransport. + Rate Limiting -GitHub imposes a rate limit on all API clients. Unauthenticated clients are +GitHub imposes a rate limit on all API clients. Unauthenticated clients are limited to 60 requests per hour, while authenticated clients can make up to -5,000 requests per hour. To receive the higher rate limit when making calls +5,000 requests per hour. To receive the higher rate limit when making calls that are not issued on behalf of a user, use the UnauthenticatedRateLimitedTransport. The Rate method on a client returns the rate limit information based on the most -recent API call. This is updated on every call, but may be out of date if it's +recent API call. This is updated on every call, but may be out of date if it's been some time since the last API call and other clients have made subsequent -requests since then. You can always call RateLimits() directly to get the most +requests since then. You can always call RateLimits() directly to get the most up-to-date rate limit data for the client. To detect an API rate limit error, you can check if its type is *github.RateLimitError: @@ -79,11 +90,9 @@ Conditional Requests The GitHub API has good support for conditional requests which will help prevent you from burning through your rate limit, as well as help speed up your -application. go-github does not handle conditional requests directly, but is -instead designed to work with a caching http.Transport. We recommend using -https://github.com/gregjones/httpcache, which can be used in conjunction with -https://github.com/sourcegraph/apiproxy to provide additional flexibility and -control of caching rules. +application. go-github does not handle conditional requests directly, but is +instead designed to work with a caching http.Transport. We recommend using +https://github.com/gregjones/httpcache for that. Learn more about GitHub conditional requests at https://developer.github.com/v3/#conditional-requests. @@ -93,7 +102,7 @@ Creating and Updating Resources All structs for GitHub resources use pointer values for all non-repeated fields. This allows distinguishing between unset fields and those set to a zero-value. Helper functions have been provided to easily create these pointers for string, -bool, and int values. For example: +bool, and int values. For example: // create a new private repository named "foo" repo := &github.Repository{ @@ -106,11 +115,14 @@ Users who have worked with protocol buffers should find this pattern familiar. Pagination -All requests for resource collections (repos, pull requests, issues, etc) +All requests for resource collections (repos, pull requests, issues, etc.) support pagination. Pagination options are described in the -ListOptions struct and passed to the list methods directly or as an +github.ListOptions struct and passed to the list methods directly or as an embedded type of a more specific list options struct (for example -PullRequestListOptions). Pages information is available via Response struct. +github.PullRequestListOptions). Pages information is available via the +github.Response struct. + + client := github.NewClient(nil) opt := &github.RepositoryListByOrgOptions{ ListOptions: github.ListOptions{PerPage: 10},