rename quickly -> gander

simonpcouch · Dec 19, 2024 · 2349e32 · 2349e32
1 parent 03d97cf
commit 2349e32
Show file tree

Hide file tree

Showing 18 changed files with 70 additions and 70 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,4 +1,4 @@
-^quickly\.Rproj$
+^gander\.Rproj$
 ^\.Rproj\.user$
 ^LICENSE\.md$
 ^README\.Rmd$

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,4 +1,4 @@
-Package: quickly
+Package: gander
 Title: LLMs at the tooltip
 Version: 0.0.0.9000
 Authors@R: 
@@ -14,8 +14,8 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
-URL: https://github.com/simonpcouch/quickly, https://simonpcouch.github.io/quickly/
-BugReports: https://github.com/simonpcouch/quickly/issues
+URL: https://github.com/simonpcouch/gander, https://simonpcouch.github.io/gander/
+BugReports: https://github.com/simonpcouch/gander/issues
 Imports: 
     cli (>= 3.6.3),
     coro (>= 1.1.0),

diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
 YEAR: 2024
-COPYRIGHT HOLDER: quickly authors
+COPYRIGHT HOLDER: gander authors
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2024 quickly authors
+Copyright (c) 2024 gander authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/NAMESPACE b/NAMESPACE
@@ -1,6 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
-export(quickly_addin)
+export(gander_addin)
 import(rlang)
 importFrom(elmer,content_image_file)
 importFrom(glue,glue)
diff --git a/R/addin.R b/R/addin.R
@@ -1,16 +1,16 @@
-#' Run the quickly addin
+#' Run the gander addin
 #'
 #' @returns
 #' Nothing. Called for its side effects, modifying the current RStudio editor
 #' based on user input. Will error if no text is entered in the dialog.
 #'
 #' @export
-quickly_addin <- function() {
+gander_addin <- function() {
   context <- rstudioapi::getActiveDocumentContext()
 
   # suppress "Listening on..." message and rethrow errors with new context
   try_fetch(
-    suppressMessages(res <- quickly_addin_impl(
+    suppressMessages(res <- gander_addin_impl(
       has_selection = !identical(rstudioapi::primary_selection(context)$text, "")
     )),
     error = function(cnd) {cli::cli_abort(conditionMessage(cnd), call = NULL)}
@@ -32,7 +32,7 @@ quickly_addin <- function() {
   invisible()
 }
 
-quickly_addin_impl <- function(has_selection) {
+gander_addin_impl <- function(has_selection) {
   minimum_context <- ifelse(has_selection, "Selection", "None")
   ui_elements <- list(
     shiny::textInput("text", "Enter text:",

diff --git a/R/assistant.R b/R/assistant.R
@@ -1,12 +1,12 @@
-#' Options used by the quickly package
+#' Options used by the gander package
 #'
 #' @description
-#' The quickly package makes use of two notable user-facing options:
+#' The gander package makes use of two notable user-facing options:
 #'
-#' * `.quickly_fn` and `.quickly_args` determine the underlying LLM powering the
+#' * `.gander_fn` and `.gander_args` determine the underlying LLM powering the
 #'   assistant.
 #'
-#' @name quickly_options
+#' @name gander_options
 NULL
 
 initialize_assistant <- function(context, input) {
@@ -20,12 +20,12 @@ initialize_assistant <- function(context, input) {
 }
 
 new_chat <- function(
-    fn = getOption(".quickly_fn", default = "chat_claude"),
+    fn = getOption(".gander_fn", default = "chat_claude"),
     ...,
     .ns = "elmer"
 ) {
   args <- list(...)
-  default_args <- getOption(".quickly_args", default = list())
+  default_args <- getOption(".gander_args", default = list())
   args <- modifyList(default_args, args)
 
   rlang::eval_bare(rlang::call2(fn, !!!args, .ns = .ns))

diff --git a/README.Rmd b/README.Rmd
@@ -13,29 +13,29 @@ knitr::opts_chunk$set(
 )
 ```
 
-# quickly
+# gander
 
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
-[![CRAN status](https://www.r-pkg.org/badges/version/quickly)](https://CRAN.R-project.org/package=quickly)
-[![R-CMD-check](https://github.com/simonpcouch/quickly/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/simonpcouch/quickly/actions/workflows/R-CMD-check.yaml)
+[![CRAN status](https://www.r-pkg.org/badges/version/gander)](https://CRAN.R-project.org/package=gander)
+[![R-CMD-check](https://github.com/simonpcouch/gander/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/simonpcouch/gander/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-The quickly package allows [elmer](https://elmer.tidyverse.org) chats to interface directly with your RStudio and Positron sessions. After (optionally) selecting some code, press the keyboard shortcut you've chosen to trigger the assistant (we suggest `Ctrl+Cmd+H`, as in "help") and write your request.
+The gander package allows [elmer](https://elmer.tidyverse.org) chats to interface directly with your RStudio and Positron sessions. After (optionally) selecting some code, press the keyboard shortcut you've chosen to trigger the assistant (we suggest `Ctrl+Cmd+H`, as in "help") and write your request.
 
 ## Installation
 
-You can install quickly like so:
+You can install gander like so:
 
 ``` r
-pak::pak("simonpcouch/quickly")
+pak::pak("simonpcouch/gander")
 ```
 
-Then, ensure that you have an [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment variable set, and you're ready to go. If you'd like to use an LLM other than Anthropic's Claude 3.5 Sonnet—like OpenAI's ChatGPT or a local ollama model—to power the quickly see `?quickly_options`.
+Then, ensure that you have an [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment variable set, and you're ready to go. If you'd like to use an LLM other than Anthropic's Claude 3.5 Sonnet—like OpenAI's ChatGPT or a local ollama model—to power the gander see `?gander_options`.
 
-The quickly assistant is interfaced with the via the quickly addin. For easiest access, we recommend registering the quickly addin to a keyboard shortcut.
+The gander assistant is interfaced with the via the gander addin. For easiest access, we recommend registering the gander addin to a keyboard shortcut.
 
-**In RStudio**, navigate to `Tools > Modify Keyboard Shortcuts > Search "quickly"`—we suggest `Ctrl+Alt+H` (or `Ctrl+Cmd+H` on macOS).
+**In RStudio**, navigate to `Tools > Modify Keyboard Shortcuts > Search "gander"`—we suggest `Ctrl+Alt+H` (or `Ctrl+Cmd+H` on macOS).
 
 **In Positron**, you'll need to open the command palette, run "Open Keyboard Shortcuts (JSON)", and paste the following into your `keybindings.json`:
 
@@ -46,20 +46,20 @@ The quickly assistant is interfaced with the via the quickly addin. For easiest
         "when": "editorTextFocus",
         "args": {
             "langId": "r",
-            "code": "quickly::quickly_addin()",
+            "code": "gander::gander_addin()",
             "focus": true
         }
     }
 ```
 
 The analogous keybinding on non-macOS is `Ctrl+Alt+H`. That said, change the `"key"` entry to any keybinding you wish!
 
-Once those steps are completed, you're ready to use the quickly assistant with a keyboard shortcut.
+Once those steps are completed, you're ready to use the gander assistant with a keyboard shortcut.
 
 ## Example
 
 ```{r}
 #| echo: false
 #| fig.alt: "A screencast demonstrating usage. In an RStudio session, I select some ggplot code, trigger the addin and type 'add axis labels', and then the model adds the needed code in-place."
-knitr::include_graphics("https://raw.githubusercontent.com/simonpcouch/quickly/refs/heads/main/inst/figs/quickly.gif")
+knitr::include_graphics("https://raw.githubusercontent.com/simonpcouch/gander/refs/heads/main/inst/figs/gander.gif")
 ```
diff --git a/README.md b/README.md
@@ -1,43 +1,43 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# quickly
+# gander
 
 <!-- badges: start -->
 
 [![Lifecycle:
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![CRAN
-status](https://www.r-pkg.org/badges/version/quickly)](https://CRAN.R-project.org/package=quickly)
-[![R-CMD-check](https://github.com/simonpcouch/quickly/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/simonpcouch/quickly/actions/workflows/R-CMD-check.yaml)
+status](https://www.r-pkg.org/badges/version/gander)](https://CRAN.R-project.org/package=gander)
+[![R-CMD-check](https://github.com/simonpcouch/gander/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/simonpcouch/gander/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-The quickly package allows [elmer](https://elmer.tidyverse.org) chats to
+The gander package allows [elmer](https://elmer.tidyverse.org) chats to
 interface directly with your RStudio and Positron sessions. After
 (optionally) selecting some code, press the keyboard shortcut you’ve
 chosen to trigger the assistant (we suggest `Ctrl+Cmd+H`, as in “help”)
 and write your request.
 
 ## Installation
 
-You can install quickly like so:
+You can install gander like so:
 
 ``` r
-pak::pak("simonpcouch/quickly")
+pak::pak("simonpcouch/gander")
 ```
 
 Then, ensure that you have an
 [`ANTHROPIC_API_KEY`](https://console.anthropic.com/) environment
 variable set, and you’re ready to go. If you’d like to use an LLM other
 than Anthropic’s Claude 3.5 Sonnet—like OpenAI’s ChatGPT or a local
-ollama model—to power the quickly see `?quickly_options`.
+ollama model—to power the gander see `?gander_options`.
 
-The quickly assistant is interfaced with the via the quickly addin. For
-easiest access, we recommend registering the quickly addin to a keyboard
+The gander assistant is interfaced with the via the gander addin. For
+easiest access, we recommend registering the gander addin to a keyboard
 shortcut.
 
 **In RStudio**, navigate to
-`Tools > Modify Keyboard Shortcuts > Search "quickly"`—we suggest
+`Tools > Modify Keyboard Shortcuts > Search "gander"`—we suggest
 `Ctrl+Alt+H` (or `Ctrl+Cmd+H` on macOS).
 
 **In Positron**, you’ll need to open the command palette, run “Open
@@ -51,7 +51,7 @@ Keyboard Shortcuts (JSON)”, and paste the following into your
         "when": "editorTextFocus",
         "args": {
             "langId": "r",
-            "code": "quickly::quickly_addin()",
+            "code": "gander::gander_addin()",
             "focus": true
         }
     }
@@ -60,9 +60,9 @@ Keyboard Shortcuts (JSON)”, and paste the following into your
 The analogous keybinding on non-macOS is `Ctrl+Alt+H`. That said, change
 the `"key"` entry to any keybinding you wish!
 
-Once those steps are completed, you’re ready to use the quickly
+Once those steps are completed, you’re ready to use the gander
 assistant with a keyboard shortcut.
 
 ## Example
 
-<img src="https://raw.githubusercontent.com/simonpcouch/quickly/refs/heads/main/inst/figs/quickly.gif" alt="A screencast demonstrating usage. In an RStudio session, I select some ggplot code, trigger the addin and type 'add axis labels', and then the model adds the needed code in-place." width="100%" />
+<img src="https://raw.githubusercontent.com/simonpcouch/gander/refs/heads/main/inst/figs/gander.gif" alt="A screencast demonstrating usage. In an RStudio session, I select some ggplot code, trigger the addin and type 'add axis labels', and then the model adds the needed code in-place." width="100%" />
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -1,4 +1,4 @@
-url: https://simonpcouch.github.io/quickly/
+url: https://simonpcouch.github.io/gander/
 template:
   bootstrap: 5
 
diff --git a/quickly.Rproj → gander.Rproj b/quickly.Rproj → gander.Rproj
diff --git a/inst/figs/quickly.gif → inst/figs/gander.gif b/inst/figs/quickly.gif → inst/figs/gander.gif
diff --git a/inst/rstudio/addins.dcf b/inst/rstudio/addins.dcf
@@ -1,4 +1,4 @@
-Name: Quickly LLM assistant
+Name: gander LLM assistant
 Description: LLM assistant
-Binding: quickly_addin
+Binding: gander_addin
 Interactive: false
diff --git a/man/quickly-package.Rd b/man/quickly-package.Rd
diff --git a/man/quickly_addin.Rd b/man/quickly_addin.Rd
diff --git a/man/quickly_options.Rd b/man/quickly_options.Rd
diff --git a/tests/testthat.R b/tests/testthat.R
@@ -7,6 +7,6 @@
 # * https://testthat.r-lib.org/articles/special-files.html
 
 library(testthat)
-library(quickly)
+library(gander)
 
-test_check("quickly")
+test_check("gander")
diff --git a/tests/testthat/test-assistant.R b/tests/testthat/test-assistant.R
@@ -1,7 +1,7 @@
 test_that("new_chat() uses claude by default", {
   withr::local_options(
-    .quickly_fn = NULL,
-    .quickly_args = NULL
+    .gander_fn = NULL,
+    .gander_args = NULL
   )
 
   testthat::with_mocked_bindings(
@@ -16,8 +16,8 @@ test_that("new_chat() uses claude by default", {
 
 test_that("new_chat() uses custom function and args", {
   withr::local_options(
-    .quickly_fn = "chat_openai",
-    .quickly_args = list(model = "gpt-4o")
+    .gander_fn = "chat_openai",
+    .gander_args = list(model = "gpt-4o")
   )
 
   testthat::with_mocked_bindings(
@@ -35,7 +35,7 @@ test_that("new_chat() uses custom function and args", {
 
 test_that("new_chat() supplied args override default args", {
   withr::local_options(
-    .quickly_args = list(temperature = 0.7)
+    .gander_args = list(temperature = 0.7)
   )
 
   testthat::with_mocked_bindings(