In ropenscilabs/keybase: Tools to Work with the 'Keybase' 'API'

keybase : Tools to Work with the 'Keybase' 'API'

'Keybase' (https://keybase.io) is a directory of people and public keys and provides methods for obtaining public keys, validating users and exchanging files and/or messages in a secure fashion. Tools are provided to search for and retrieve information about 'Keybase' users, retrieve and import user public keys and list and/or download files.

There's also a thin but useful R wrapper around many of they keybase command-line utility functions.

The following functions are implemented:

General:

• kb_discover: Check Keybase membership and retrieve basic user info
• kb_get_public_keys: Retrive the public key(s) for a given user
• kb_lookup: Retrieve info on Keybase user(s)
• kb_cmd: Execute a keybase command-line command
• kb_followers: Get keybase followers
• kb_following: Get who you're following on keybase
• kb_whoami: Who does Keybase think you are?

Crypto

• kb_encrypt_file: Encrypt a file
• kb_decrypt_file: Decrypt a file
• kb_encrypt_msg: Encrypt a message
• kb_decrypt_msg: Decrypt a message

Filesystem:

• kb_list_files: List directory path contents in a Keybase user's public folder
• kb_file_exists: See if a file exists
• kb_read_file: Read a resource (file) from a Keybase public folder
• kb_read_rds: Share RDS files with other Keybase users
• kb_write_rds: Share RDS files with other Keybase users

Utility:

• kb_raw_url: Turn a user + path into a Keybase "raw" URL

Diagnostics:

• kb_ping: Test connectivity to the keybase server
• kbfs_errors: Retrieve KBFS error log
• kbfs_metrics: Retrieve KBFS performance metrics

Installation

devtools::install_github("ropenscilabs/keybase")

options(width=120)

Usage

library(keybase)
library(tidyverse)

# current verison
packageVersion("keybase")

kb_ping()

kb_discover(twitter=c("hrbrmstr", "_inundata", "briandconnelly"), github="bearloga")

kb_discover(twitter=c("sckottie", "_inundata", "briandconnelly"), kb_usernames_only=TRUE)

kb_lookup("karthik")

kb_list_files("marcopolo")

kb_list_files("marcopolo", pattern="\\.txt")

Safe(r) data sharing

kb_list_files("hrbrmstr", "data")

kb_file_exists("hrbrmstr", "index.md")

kb_file_exists("https://hrbrmstr.keybase.pub/data/Rlogo.pngd")

kb_raw_url("hrbrmstr", "data/Rlogo.png")

kb_file_exists("hrbrmstr", "data/Rlogo.png")

kb_file_exists(kb_raw_url("hrbrmstr", "data/Rlogo.png"))

kb_read_file("hrbrmstr", "data/mtcars.csv")

kb_read_file("hrbrmstr", "data/mtcars.json")

# need (for now) to use the "raw" URL for things `rio::import()` can't natively read

kb_list_files("hrbrmstr", "data", pattern = ".*.png") %>% 
  select(raw_url)

magick::image_read("https://hrbrmstr.keybase.pub/data/Rlogo.png")

Test Results

library(keybase)
library(testthat)

date()

test_dir("tests/")

ropenscilabs/keybase documentation built on May 11, 2022, 9:10 a.m.