Browse Source

copyright/README

master
boB Rudis 5 years ago
parent
commit
a988363556
No known key found for this signature in database GPG Key ID: 1D7529BE14E2BBA9
  1. 1
      DESCRIPTION
  2. 16
      README.Rmd
  3. 36
      README.md
  4. 9
      inst/COPYRIGHTS
  5. BIN
      man/figures/README-unnamed-chunk-4-1.png
  6. BIN
      man/figures/README-unnamed-chunk-5-1.png
  7. 2
      src/curlparse-main.cpp

1
DESCRIPTION

@ -14,6 +14,7 @@ SystemRequirements: libcurl: libcurl-devel (rpm) or
libcurl4-openssl-dev (deb).
URL: https://gitlab.com/hrbrmstr/curlparse
BugReports: https://gitlab.com/hrbrmstr/curlparse/issues
Copyrights: file inst/COPYRIGHTS
Suggests:
jsonlite,
tinytest,

16
README.Rmd

@ -16,6 +16,22 @@ Parse 'URLs' with 'libcurl'
Tools are provided to parse URLs using the modern 'libcurl' built-in parser.
## NOTE
You _need_ to have `libcurl` >= 7.62.0 for this to work since that's when it began to expose the URL parsing API.
macOS users can do:
```
$ brew install curl
```
(provided you're using [Homebrew](https://brew.sh/)).
Windows users are able to just install this pacakge since it uses the same, clever "anticonf" that Jeroen uses in the [{curl} pacakge](https://github.com/jeroen/curl).
The state of the availability of `libcurl` v7.62.0 across Linux distributions is sketch at best (as an example, Ubuntu bionic and comic are not even remotely at the current version). If your distribution does not have >= 7.62.0 available you will need to [compile and install it manually](https://curl.haxx.se/download.html) ensuring the library and headers are available to R to build the package.
## What's Inside The Tin
The following functions are implemented:

36
README.md

@ -5,7 +5,7 @@ developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.re
[![Signed
by](https://img.shields.io/badge/Keybase-Verified-brightgreen.svg)](https://keybase.io/hrbrmstr)
![Signed commit
%](https://img.shields.io/badge/Signed_Commits-77.8%25-lightgrey.svg)
%](https://img.shields.io/badge/Signed_Commits-80.0%25-lightgrey.svg)
[![Linux build
Status](https://travis-ci.org/hrbrmstr/curlparse.svg?branch=master)](https://travis-ci.org/hrbrmstr/curlparse)
[![Windows build
@ -25,6 +25,28 @@ Parse ‘URLs’ with ‘libcurl’
Tools are provided to parse URLs using the modern ‘libcurl’ built-in
parser.
## NOTE
You *need* to have `libcurl` \>= 7.62.0 for this to work since that’s
when it began to expose the URL parsing API.
macOS users can do:
$ brew install curl
(provided you’re using [Homebrew](https://brew.sh/)).
Windows users are able to just install this pacakge since it uses the
same, clever “anticonf” that Jeroen uses in the [{curl}
pacakge](https://github.com/jeroen/curl).
The state of the availability of `libcurl` v7.62.0 across Linux
distributions is sketch at best (as an example, Ubuntu bionic and comic
are not even remotely at the current version). If your distribution does
not have \>= 7.62.0 available you will need to [compile and install it
manually](https://curl.haxx.se/download.html) ensuring the library and
headers are available to R to build the package.
## What’s Inside The Tin
The following functions are implemented:
@ -160,9 +182,9 @@ microbenchmark(
mb
## Unit: microseconds
## expr min lq mean median uq max neval cld
## curlparse 799.909 842.713 907.3988 881.0535 924.5220 4892.528 500 b
## urltools 657.364 693.869 745.7828 721.2950 768.6505 4292.258 500 a
## expr min lq mean median uq max neval
## curlparse 650.357 685.5585 942.4718 774.454 935.5125 7926.342 500
## urltools 510.676 542.7305 770.9576 591.866 746.7820 4595.759 500
autoplot(mb)
```
@ -342,9 +364,9 @@ all(
| Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) |
| :----------- | -------: | --: | --: | ---: | ----------: | ---: | -------: | ---: |
| C++ | 2 | 0.2 | 286 | 0.68 | 65 | 0.51 | 58 | 0.32 |
| Rmd | 1 | 0.1 | 85 | 0.20 | 49 | 0.38 | 59 | 0.32 |
| R | 6 | 0.6 | 46 | 0.11 | 14 | 0.11 | 67 | 0.36 |
| C++ | 2 | 0.2 | 286 | 0.68 | 65 | 0.48 | 58 | 0.30 |
| Rmd | 1 | 0.1 | 85 | 0.20 | 56 | 0.41 | 68 | 0.35 |
| R | 6 | 0.6 | 46 | 0.11 | 14 | 0.10 | 67 | 0.35 |
| Bourne Shell | 1 | 0.1 | 2 | 0.00 | 0 | 0.00 | 0 | 0.00 |
## Code of Conduct

9
inst/COPYRIGHTS

@ -0,0 +1,9 @@
All R and C[++] code is MIT licensed as noted in the DESCRIPTION
This package uses the "anticonf" configuration script from
Jeroen Ooms' {curl} package
(https://github.com/jeroen/curl/blob/master/DESCRIPTION)
which is also MIT licensed with the following COPYRIGHT:
YEAR: 2019
COPYRIGHT HOLDER: Jeroen Ooms; RStudio

BIN
man/figures/README-unnamed-chunk-4-1.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 23 KiB

BIN
man/figures/README-unnamed-chunk-5-1.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 30 KiB

2
src/curlparse-main.cpp

@ -1,7 +1,7 @@
#include <Rcpp.h>
#include <curl/curl.h>
// #include <curl/urlapi.h>
#include <curl/urlapi.h>
using namespace Rcpp;

Loading…
Cancel
Save