-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME.Rmd
117 lines (86 loc) · 3.75 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = '#>',
fig.path = 'man/figures/README-',
out.width = '100%'
)
```
# bskyr <img src="man/figures/logo.png" align="right" height="136" alt="" />
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://www.repostatus.org/#active)
[](https://app.codecov.io/gh/christopherkenny/bskyr?branch=main)
[](https://github.com/christopherkenny/bskyr/actions/workflows/R-CMD-check.yaml)
[](https://CRAN.R-project.org/package=bskyr)
[](https://christopherkenny.r-universe.dev/bskyr)
<!-- badges: end -->
`bskyr` provides an interface to the Bluesky Social API, allowing you to interact with Bluesky Social from R.
To do this, we provide functions which match with the [AT Protocol's Lexicon](https://atproto.com/guides/lexicon), which is like using regular HTTP requests.
Outputs from `bskyr`'s functions are primarily `tibble`s, allowing for easy analysis of the outputs from the API calls.
## Installation
You can install the stable version of `bskyr` from [CRAN](https://cran.r-project.org/package=bskyr) with:
```r
install.packages('bskyr')
```
You can install the development version of `bskyr` from [GitHub](https://github.com/) with:
``` r
# install.packages('pak')
pak::pak('christopherkenny/bskyr')
```
## Posting with `bskyr`
First, load the package:
```{r}
library(bskyr)
```
Text posts can be made as follows:
```r
bs_post(text = 'Your text goes here.')
```
If you have images to include, up to four can be included with the `images` argument:
```r
bs_post(
text = 'Your text goes here.',
images = c('path/to/image1.jpg', 'path/to/image2.png')
)
```
Alt text can be added to images with the `images_alt` argument:
```r
bs_post(
text = 'Your text goes here.',
images = c('path/to/image1.jpg', 'path/to/image2.png'),
images_alt = c('Alt text for image 1', 'Alt text for image 2')
)
```
To quote or reply to a post, use the `quote` and/or `reply` argument, respectively.
These can take the link of an existing post.
You can quote and reply to the same post, if you want.
```r
bs_post(
text = 'Your text goes here.',
quote = 'https://bsky.app/profile/chriskenny.bsky.social/post/3kepscxiljc22',
reply = 'https://bsky.app/profile/chriskenny.bsky.social/post/3kepscxiljc22'
)
```
See the reference for additional features, including likes with `bs_like()` and reposts with `bs_repost()`.
## Authentication
To authenticate, you first need to make an App Password.
To do this, go to `https://bsky.app/settings`.
Under "Advanced" click App passwords and then "Add App Password."
Once you have a password, you need to run:
```r
set_bluesky_user('YOUR-USERNAME.bsky.social')
set_bluesky_pass('your-apps-pass-word')
```
If you want this to persist across sessions, set `install = TRUE` and `r_env = file.path(Sys.getenv('HOME'), '.Renviron')`.
This will save your credentials in your R environment file.
Alternatively, you can set them manually using `usethis::edit_r_environ()` and adding lines like so:
```
BLUESKY_APP_USER='YOUR-USERNAME.bsky.social'
BLUESKY_APP_PASS='your-apps-pass-word'
```
##