Repository files navigation

An HTTP client, taking inspiration from Ruby'sfaraday and Python'srequests

Package documentation:https://docs.ropensci.org/crul/

Some Features:

• HttpClient - Main interface to making HTTP requests. Synchronous requests only.
• HttpResponse - HTTP response object, used for all responses across thedifferent clients.
• Paginator - Auto-paginate through requests - supports a subset of all possiblepagination scenarios - will fill out more scenarios soon
• Async - Asynchronous HTTP requests - a simple interface for many URLS -whose interface is similar toHttpClient - all URLs are treated the same.
• AsyncVaried - Asynchronous HTTP requests - accepts any number ofHttpRequestobjects - with a different interface thanHttpClient/Async due to the natureof 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 requestsas well as async requests
• Hooks on requests and responses are available in theHttpClient 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 withwebmockr to mockHTTP requests. Checkout thehttp testing book
• Test caching:crul also integrates withvcr to cache http requests/responses. Checkout thehttp testing book

CRAN version

install.packages("crul")

Latest binaries from rOpenSci

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

Dev version from GitHub

install.packages("pak")pak::pak("ropensci/crul")

library("crul")

• Pleasereport any issues or bugs.
• License: MIT
• Get citation information forcrul in R doingcitation(package = 'crul')
• Please note that this package is released with aContributor 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 ideaarose from a tweet - 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.