Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emitanaka/rtodoist
R interface to todoist.com
https://github.com/emitanaka/rtodoist
Last synced: about 1 month ago
JSON representation
R interface to todoist.com
- Host: GitHub
- URL: https://github.com/emitanaka/rtodoist
- Owner: emitanaka
- License: gpl-3.0
- Created: 2012-05-29T05:10:44.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-12-15T00:41:27.000Z (almost 2 years ago)
- Last Synced: 2024-08-13T07:15:40.906Z (4 months ago)
- Language: R
- Size: 85.9 KB
- Stars: 9
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - emitanaka/rtodoist - R interface to todoist.com (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rtodoist
[](https://www.tidyverse.org/lifecycle/#experimental)
This R package is an interface to [todoist](https://todoist.com) - the todo list manager.
## Installation
Package is still in early development but you can install the latest version using the `devtools` package.
``` r
# install.packages("devtools")
devtools::install_github("karthik/rtodoist")
```
## Getting your API token
First you will need to get the API token from your account.
If you login to your todoist account, you can find this under Settings > Integrations > API token or by clicking [here](https://todoist.com/prefs/integrations) and scroll to the bottom.
You are recommended that you place your token in the `.Renviron` file by adding to it:
```
TODOIST_API_TOKEN=
```
The easiest way to access the `.Renviron` is to use `usethis::edit_r_environ()`.
That way you no longer have to specify a token for any `rtodoist` functions. Of course, you can also just specifiy it inline using `token=...`.
## Modifying projects on todoist
The `rtodoist` R package has a family of functions that can manipulate and view information on projects. These famliy of functions all start with `proj_`. E.g. use
```{r, eval=F}
proj_add("My awesome project")
```
to add a new project called "My awesome project". You will need to have your token environment setup for this to work or alternatively if you have your API token string you can supply it to the argument `token`.
```{r, eval=F}
proj_add("My awesome project", token = "")
```
Other projected related functions include:
```{r, echo=F, results='asis'}
library(rtodoist)
fns <- ls("package:rtodoist")
proj_fns <- fns[stringr::str_starts(fns, 'proj')]
proj_fns <- setdiff(proj_fns, "proj_add")
cat(paste0(paste0(clisymbols::symbol$bullet, "`", proj_fns, "`"), collapse = "\n\n"), ".")
```
## Modifying tasks on todoist
Similarily, the `rtodoist` package has a family of functions to modify and view information on tasks. These functions all start with `task_`. E.g. use
```{r, eval=F}
task_add(content = "Get rtodoist documentation done.",
due_string = "Tomorrow")
```
to add a task that is due tomorrow.
Other task related functions include:
```{r, echo=F, results='asis'}
task_fns <- fns[stringr::str_starts(fns, 'task')]
task_fns <- setdiff(task_fns, c("task_add", "task_clean"))
cat(paste0(paste0(clisymbols::symbol$bullet, "`", task_fns, "`"), collapse = "\n\n"), ".")
```