Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jbgruber/atrrr
AT Protocol (Authenticated Transfer Protocol behind Bluesky) R package
https://github.com/jbgruber/atrrr
atproto bluesky r
Last synced: 2 months ago
JSON representation
AT Protocol (Authenticated Transfer Protocol behind Bluesky) R package
- Host: GitHub
- URL: https://github.com/jbgruber/atrrr
- Owner: JBGruber
- License: other
- Created: 2023-09-27T17:37:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-01T12:41:27.000Z (3 months ago)
- Last Synced: 2024-10-15T04:10:06.211Z (2 months ago)
- Topics: atproto, bluesky, r
- Language: R
- Homepage: https://jbgruber.github.io/atrrr
- Size: 34.6 MB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
message = FALSE,
warning = FALSE,
fig.path = "man/figures/README-",
out.width = "100%"
)
knitr::knit_hooks$set(document = function(x, options)
gsub("(figures/", "(vignettes/figures/", x, fixed = TRUE))
library(dplyr)
library(purrr)
```
# atrrr 
[](https://CRAN.R-project.org/package=atrrr)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/JBGruber/atrrr/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/JBGruber/atrrr?branch=main)
[](https://saythanks.io/to/JBGruber)
The goal of atrrr^[before 2024-01-04, this package was [called `atr`](https://github.com/JBGruber/atrrr/issues/12).] is to wrap the AT Protocol (Authenticated Transfer Protocol) behind Bluesky. [*And we have actually already fulfilled this goal!*](#want-to-help).
The entire protocol is open and documented in so-called [lexicons](https://atproto.com/guides/lexicon), from which we autogenerated `R` functions.
These are not exported, however, since dealing with them is a bit advanced.
Rather we have some nice human-generated functions with documentation and examples.
## Installation
You can install the development version of `atrrr` like so (install the `remotes` package first, with `install.packages("remotes")`, if you don't have that yet):
``` r
# install.packages("remotes")
remotes::install_github("JBGruber/atrrr")
```
## Load the package
```{r setup}
library(atrrr)
```
## Authentication
The first time you make a request, you will be prompted automatically to enter your user handle and an app password to authenticate `atrrr` to communicate with BlueSky for you.
The page to generate app passwords is also automatically opened for you.
However, you can also trigger this process manually:
```{r eval=FALSE}
auth("jbgruber.bsky.social")
```
This can be useful if you want to replace an old token as it is permanently stored encrypted on disk.
## Retrieve Skeets (`get_skeets_authored_by`)
To fetch all the skeets by a specific user, use the `get_skeets_authored_by` function. *Note this also includes quote skeets and reskeets.* You can also opt not to parse the result by setting `parse = FALSE`, however it is recommended to use the default parse option which results in a (more) tidy tibble.
```{r}
get_skeets_authored_by(actor = "benguinaudeau.bsky.social", parse = TRUE) |>
dplyr::glimpse()
```
## Analyzing Feeds on Blue Sky
On Blue Sky users have the ability to create custom feeds based on specific keywords. These feeds aggregate content, for instance, a user might curate a feed around the hashtag `#rstats` to gather all relevant content about. Let's delve into the dynamics of such feeds.
Our starting point is to extract the posts from the `#rstats` feed created by "andrew.heiss.phd".
```{r}
# Fetching the feed posts
feeds <- get_feeds_created_by(actor = "andrew.heiss.phd")
# Filtering for a specific keyword, for example "#rstats"
rstat_feed <- feeds |>
filter(displayName == "#rstats")
# Extracting posts from this curated feed
rstat_posts <- get_feed(rstat_feed$uri, limit = 200) |>
dplyr::glimpse()
```
## Learn More?
Start with the [Basic Usage](https://jbgruber.github.io/atrrr/articles/Basic_Usage.html) vignette to learn more.
# Want to help?
You can help by creating an [issue](https://github.com/JBGruber/atrrr/issues/new/choose) requesting new features or reporting bugs.
If you are a developer, we are happy to accept pull requests.
It should be fairly straightforward, as all endpoints are already covered by automatically generated function.
For example, the endpoint [app.bsky.actor.getProfiles](https://docs.bsky.app/docs/api/app-bsky-actor-get-profiles) is accessible via `atrrr:::app_bsky_actor_get_profiles()`.
The function `get_user_info()` is just a thin wrapper around that and calls an optional parsing function:
```
get_user_info <- function(actor,
parse = TRUE,
.token = NULL) {
# we need to use do.call so objects are passed to the right environment
res <- do.call(
what = app_bsky_actor_get_profiles,
args = list(
actor,
.token = .token, # tokens are handled automatically under the hood
.return = "json"
)) |>
purrr::pluck("profiles")
if (parse) {
res <- parse_actors(res)
}
return(res)
}
```
If you find an endpoint at that interests you, you can write a similar wrapper and contribute it to the package (or build something new on top of it).
But please open an [issue](https://github.com/JBGruber/atrrr/issues) first, so we don't do duplicated work.