github

package

v0.8.0 Latest Latest Go to latest Published: Feb 14, 2020 License: MIT Imports: 10 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/gdm85/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 GetFileSize(f *os.File) (int64, error)
type Client
- func (c *Client) DoAuthRequest(method, url, mime string, headers map[string]string, body io.Reader) (*http.Response, error)
- func (c *Client) Get(uri string, v interface{}) error

Constants ¶

View Source

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

Variables ¶

View Source

var VERBOSITY = 0

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

Functions ¶

func GetFileSize ¶

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

Types ¶

type Client ¶

type Client struct {
	// AuthUser is the GitHub user which is authenticating.
	AuthUser string
	// Token is the GitHub API token, used when set.
	Token string
	// BaseURL is the GitHub API URL, defaults to DefaultBaseURL if unset.
	BaseURL string
}

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 (*Client) DoAuthRequest ¶ added in v0.8.0

func (c *Client) DoAuthRequest(method, url, mime 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 (*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.

Source Files ¶

View all Source files

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