https://github.com/ropensci/crul

R6 based http client for R (for developers)
https://github.com/ropensci/crul

api async curl http r r-package rstats

Last synced: about 1 month ago
JSON representation

R6 based http client for R (for developers)

• Host: GitHub
• URL: https://github.com/ropensci/crul
• Owner: ropensci
• License: other
• Created: 2016-10-28T23:29:59.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-07-23T19:46:57.000Z (about 2 months ago)
• Last Synced: 2024-07-23T23:12:39.960Z (about 2 months ago)
• Topics: api, async, curl, http, r, r-package, rstats
• Language: R
• Homepage: https://docs.ropensci.org/crul
• Size: 1.79 MB
• Stars: 102
• Watchers: 11
• Forks: 16
• Open Issues: 15
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codemeta: codemeta.json

Awesome Lists containing this project

• jimsghstars - ropensci/crul - R6 based http client for R (for developers) (R)

README

        
# crul 

```{r echo=FALSE}

knitr::opts_chunk$set(

  comment = "#>",

  collapse = TRUE,

  warning = FALSE

)

```

[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![R-check](https://github.com/ropensci/crul/workflows/R-check/badge.svg)](https://github.com/ropensci/crul/actions/)

[![codecov](https://codecov.io/gh/ropensci/crul/graph/badge.svg?token=q7rQCfvbsy)](https://codecov.io/gh/ropensci/crul)

[![cran checks](https://badges.cranchecks.info/worst/crul.svg)](https://cloud.r-project.org/web/checks/check_results_crul.html)

[![rstudio mirror downloads](https://cranlogs.r-pkg.org/badges/crul)](https://github.com/r-hub/cranlogs.app)

[![cran version](https://www.r-pkg.org/badges/version/crul)](https://cran.r-project.org/package=crul)

An HTTP client, taking inspiration from Ruby's [faraday](https://rubygems.org/gems/faraday) and Python's `requests`

Package documentation: 

Some Features:

* `HttpClient` - Main interface to making HTTP requests. Synchronous requests only.

* `HttpResponse` - HTTP response object, used for all responses across the

different clients.

* `Paginator` - Auto-paginate through requests - supports a subset of all possible

pagination scenarios - will fill out more scenarios soon

* `Async` - Asynchronous HTTP requests - a simple interface for many URLS -

whose interface is similar to `HttpClient` - all URLs are treated the same.

* `AsyncVaried` - Asynchronous HTTP requests - accepts any number of `HttpRequest`

objects - with a different interface than `HttpClient`/`Async` due to the nature

of handling requests with different HTTP methods, options, etc.

* set curl options globally: `set_auth()`, `set_headers()`, and more

* Writing to disk and streaming: available with both synchronous requests

as well as async requests

* Hooks on requests and responses are available in the `HttpClient` method only, 

and allow you to trigger functions to run on requests or responses, or both.

See `?hooks` for the details and examples

* Mocking: `crul` integrates with [webmockr](https://github.com/ropensci/webmockr) to mock

HTTP requests. Checkout the [http testing book][book]

* Test caching: `crul` also integrates with [vcr](https://github.com/ropensci/vcr) to cache http requests/responses. Checkout the [http testing book][book]

## Installation

CRAN version

```{r eval=FALSE}

install.packages("crul")

```

Latest binaries from rOpenSci

```{r eval=FALSE}

install.packages("crul", repos = "https://dev.ropensci.org")

```

Dev version from GitHub

```{r eval=FALSE}

install.packages("pak")

pak::pak("ropensci/crul")

```

```{r}

library("crul")

```

## Meta

* Please [report any issues or bugs](https://github.com/ropensci/crul/issues).

* License: MIT

* Get citation information for `crul` in R doing `citation(package = 'crul')`

* Please note that this package is released with a [Contributor Code of Conduct](https://ropensci.org/code-of-conduct/). By contributing to this project, you agree to abide by its terms.

* Where does the package name come from? It was a play on "curl", the popular command line client.

* Where does the sticker design come from? The sticker idea [arose from a tweet](https://github.com/ropensci/crul/issues/42) - crul is close (ish) to Krull, a 1980's movie with a "mystical five-pointed weapon". The association with Krull was not known before naming the package.

[book]: https://books.ropensci.org/http-testing/