Learn R Programming

github (version 0.9.8)

interactive.login: Obtain a github context interactively

Description

interactive.login opens a web browser, asks for your username+password, performs the OAuth dance, retrieves the token, and uses it to create a github context.

Usage

interactive.login(client_id = NULL, client_secret = NULL, scopes = NULL,
  base_url = "https://github.com", api_url = "https://api.github.com",
  max_etags = 10000, verbose = FALSE)

Arguments

client_id

the github client ID

client_secret

the github client secret

scopes

the OAuth scopes you want to request

base_url

the base URL for the github webpage. Change this in GitHub Enterprise deployments to your base G.E. URL

api_url

the base URL for the github API. Change this in GitHub Enterprise deployments to your base G.E. API URL

max_etags

the maximum number of entries to cache in the context

verbose

logical, passed to create.github.context and, ultimately, to httr configuration

Value

a github context object that is used in every github API call issued by this library.

Details

If you use rgithub interactively, then you will get a default client ID and client secret that you can use. Please don't abuse that, or the feature might need to be removed.

Refer to http://developer.github.com/guides/basics-of-authentication/