https://github.com/andrie/prodpad
R package that wraps the ProdPad API
https://github.com/andrie/prodpad
Last synced: about 1 month ago
JSON representation
R package that wraps the ProdPad API
- Host: GitHub
- URL: https://github.com/andrie/prodpad
- Owner: andrie
- License: other
- Created: 2022-08-20T06:58:15.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-30T12:21:17.000Z (over 2 years ago)
- Last Synced: 2025-02-14T13:17:01.217Z (3 months ago)
- Language: R
- Homepage: https://andrie.github.io/prodpad/
- Size: 720 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
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 = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# prodpad 
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
The `prodpad` packages exposes higher level APIs to extract tibbles with ProdPad information (for example, products, feedback, ideas, etc.) from the ProdPad API.
In addition, `prodpad` provides a low level wrapper around the ProdPad API - the `pp()` function.
## Installation
You can install the development version of prodpad from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("andrie/prodpad")
```
## Authenticating against the API
To get started, you need a ProdPad API key. This can be found by going to:
[Profile => API Keys](https://app.prodpad.com/me/apikeys). (Or use
`prodpad::browse_api_key()` to navigate there interactively)
Then export that API key as an environment variable, e.g. in `.Renviron`:
``` bash
PRODPAD_API_KEY=my-api-key
```
## Example
This is a basic example which shows you how to solve a common problem:
``` r
library(prodpad)
pp_get_products()
```
## Acknowledgements
Cole Arendt also wrote a `prodpad` [package](https://github.com/colearendt/prodpad), using R6 classes to represent the connection to Prodpad. However, this implementation was inspired by the `gh` [package](https://github.com/r-lib/gh) by Gábor Csárdi. I found the ideas of `gh` to be more flexible and ported `gh` in its entirety to the `pp()` function in `prodpad`.
## Trademarks
The ProdPad name and logo are trademarks of ProdPad (CreateSHIFT Ltd.). The author of this package has no affiliation with ProdPad.