github

package

v0.7.5 Latest Latest Go to latest Published: Feb 14, 2020 License: MIT Imports: 11 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

Repository

github.com/meterup/github-release

Links

Open Source Insights

Documentation ¶

Overview ¶

Package github is a mini-library for querying the GitHub v3 API that takes care of authentication (with tokens only) and pagination.

Index ¶

Constants
Variables
func DoAuthRequest(method, url, mime, token string, headers map[string]string, body io.Reader) (*http.Response, error)
func GetFileSize(f *os.File) (int64, error)
type Client
- func NewClient(username, token string, client *rest.Client) Client

Constants ¶

View Source

const DefaultBaseURL = "https://api.github.com"

View Source

const VERSION = "0.7.5"

Variables ¶

View Source

var VERBOSITY = 0

Set to values > 0 to control verbosity, for debugging.

Functions ¶

func DoAuthRequest ¶

func DoAuthRequest(method, url, mime, token string, headers map[string]string, body io.Reader) (*http.Response, error)

DoAuthRequest ...

TODO: This function is amazingly ugly (separate headers, token, no API URL constructions, et cetera).

func GetFileSize ¶

func GetFileSize(f *os.File) (int64, error)

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client collects a few options that can be set when contacting the GitHub API, such as authorization tokens. Methods called on Client will supply these options when calling the API.

func NewClient ¶ added in v0.7.3

func NewClient(username, token string, client *rest.Client) Client

NewClient creates a new Client for use with the Github API.

func (Client) Get ¶

func (c Client) Get(uri string, v interface{}) error

Get fetches uri (relative URL) from the GitHub API and unmarshals the response into v. It takes care of pagination transparantly.

func (Client) NewRequest ¶ added in v0.7.3

func (c Client) NewRequest(method, uri string, body io.Reader) (*http.Request, error)

func (Client) SetBaseURL ¶ added in v0.7.3

func (c Client) SetBaseURL(baseurl string)

SetBaseURL updates the client's base URL, if baseurl is a non-empty value.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL