authoriseGitHub {archivist.github}

Authorise with GitHub API

Description

authoriseGitHub is function that performes OAuth authorisation with GitHub API and stores resulting token in the github_token variable. In order to authorise your app you need ClinetID and ClientSecret. They can be found here: https://github.com/settings/applications/new

Usage

authoriseGitHub(ClientID, ClientSecret, scope = c("public_repo"))

Arguments

ClientID

A 20 characters long string with Client ID. See https://github.com/settings/applications/ for more details.

ClientSecret

A 40 characters long string with Client Secret. See https://github.com/settings/applications/ for more details.

scope

A character vector with the list of availables scopes for the GitHub API token. See https://developer.github.com/v3/oauth/#scopes. For repository deletion you will need to add "delete_repo" scope.

Note

Bug reports and feature requests can be sent to https://github.com/MarcinKosinski/archivist.github/issues

Author(s)

Przemyslaw Biecek, [e-mail]

References

More about archivist.github can be found on marcinkosinski.github.io/archivist.github/ and about archivist in posts' history on https://pbiecek.github.io/archivist/articles/posts.html

See Also

Other archivist.github: archive, archivist.github-package, cloneGitHubRepo, createGitHubRepo, deleteGitHubRepo, pushGitHubRepo

Examples

## Not run: 
## GitHub version
authoriseGitHub(ClientID, ClientSecret) -> github_token

## End(Not run)