This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 3646fb3

committed

#80 update docs throughout pkg to tell users to create a GITHUB PAT with gist scope

1 parent 5f3e2d8 commit 3646fb3Copy full SHA for 3646fb3

File tree

+15

-9

lines changed

+15

-9

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ Description: Work with 'GitHub' 'gists' from 'R' (e.g.,`
`10`	`10`	`'gist' 'commits', and get rate limit information when 'authenticated'. Some`
`11`	`11`	`requests require authentication and some do not. 'Gists' website:`
`12`	`12`	`<https://gist.github.com/>.`
`13`		`-Version: 0.4.3.9210`
	`13`	`+Version: 0.4.4.9110`
`14`	`14`	`Authors@R: c(`
`15`	`15`	`person("Scott", "Chamberlain", role = c("aut", "cre"),`
`16`	`16`	`email = "myrmecocystus@gmail.com",`

Lines changed: 6 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,12 @@`
`5`	`5`	`#'`
`6`	`6`	`#' There are two ways to authorise gistr to work with your GitHub account:`
`7`	`7`	`#'`
`8`		`-#' - Generate a personal access token at`
`9`		`-#' <https://help.github.com/articles/creating-an-access-token-for-command-line-use>`
`10`		-#' and record in the `GITHUB_PAT` envar.
	`8`	`+#' - Generate a personal access token with the gist scope selected, and set it`
	`9`	+#' as the `GITHUB_PAT` environment variable per session using `Sys.setenv`
	`10`	+#' or across sessions by adding it to your `.Renviron` file or similar.
	`11`	`+#' See`
	`12`	`+#' https://help.github.com/articles/creating-an-access-token-for-command-line-use`
	`13`	`+#' for help`
`11`	`14`	`#' - Interactively login into your GitHub account and authorise with OAuth.`
`12`	`15`	`#'`
`13`	`16`	#' Using `GITHUB_PAT` is recommended.

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ library("gistr")`
`49`	`49`
`50`	`50`	`There are two ways to authorise gistr to work with your GitHub account:`
`51`	`51`
`52`		-* Generate a personal access token (PAT) at [https://help.github.com/articles/creating-an-access-token-for-command-line-use](https://help.github.com/articles/creating-an-access-token-for-command-line-use) and record it in the `GITHUB_PAT` environment variable.
	`52`	+* Generate a personal access token (PAT) with the gist scope selectedat [https://help.github.com/articles/creating-an-access-token-for-command-line-use](https://help.github.com/articles/creating-an-access-token-for-command-line-use) and record it in the `GITHUB_PAT` environment variable.
`53`	`53`	- To test out this approach, execute this in R: `Sys.setenv(GITHUB_PAT = "blahblahblah")`, where "blahblahblah" is the PAT you got from GitHub. Then take `gistr` out for a test drive.
`54`	`54`	- If that works, you will probably want to define the GITHUB_PAT environment variable in a file such as `~/.bash_profile` or `~/.Renviron`.
`55`	`55`	`* Interactively login into your GitHub account and authorise with OAuth.`

Lines changed: 6 additions & 3 deletions

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ library("gistr")`
`34`	`34`
`35`	`35`	`There are two ways to authorise gistr to work with your GitHub account:`
`36`	`36`
`37`		-* Generate a personal access token (PAT) at [https://help.github.com/articles/creating-an-access-token-for-command-line-use](https://help.github.com/articles/creating-an-access-token-for-command-line-use) and record it in the `GITHUB_PAT` envar.
	`37`	+* Generate a personal access token (PAT) with the gist scope selectedat [https://help.github.com/articles/creating-an-access-token-for-command-line-use](https://help.github.com/articles/creating-an-access-token-for-command-line-use) and record it in the `GITHUB_PAT` envar.
`38`	`38`	`* Interactively login into your GitHub account and authorise with OAuth.`
`39`	`39`
`40`	`40`	`Using the PAT is recommended.`

Comments

(0)