Skip to content

Commit

Permalink
Update README and NEWS with new changes
Browse files Browse the repository at this point in the history
  • Loading branch information
al-obrien committed Nov 15, 2023
1 parent 2137333 commit bf100c0
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 11 deletions.
7 changes: 7 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# rosv (development version)

* Upgraded to {httr2} 1.0.0
* Upgraded tests with {httrtest2} 1.0.0
* Implemented pagination as core functionality in low-level functions (e.g. `RosvQueryBatch()`)
* Remove page_token parameter from mid-level functions, all handled at low-level automatically.
* Use `httr2::req_perform_sequential()` for the `RosvVulns()` methods to get build-in helpers not
available in `purrr::map()` alone.

# rosv 0.4.2

* Initial CRAN release
Expand Down
9 changes: 4 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ knitr::opts_chunk$set(

## Overview

The {rosv} package is an API client to the [Open Source Vulnerability (OSV) database](https://osv.dev/). Both high and low level functions are available to query the database for vulnerabilities in package repositories across various open source ecosystems such as CRAN, Bioconductor, PyPI, and many more. Queries made against the OSV database are useful to check for package vulnerabilities (including by specific versions) enumerated in package management files such as `requirements.txt` (Python) and `renv.lock` (R).
The {rosv} package is an API client to the [Open Source Vulnerability (OSV) database](https://osv.dev/). Both high and low level functions are available to query the database for vulnerabilities in package repositories across various open source ecosystems such as CRAN, Bioconductor, PyPI, and many more. Queries made against the OSV database are useful to check for package vulnerabilities (including by specific versions) enumerated in package management files such as `requirements.txt` (Python) and `renv.lock` (R). Checking valid query construction, API response pagination, and parsing content are all handled by {rosv}.

Various helper functions assist in the administration of [Posit Package Manager](https://packagemanager.posit.co/client/#/) or similar services. Packages can be routinely examined for new vulnerabilities which aide in the creation and updating of curated repositories as well as assigning block lists.

Expand Down Expand Up @@ -62,7 +62,6 @@ osv_query(c('dask', 'readxl', 'dplyr'),

## Development notes

{rosv} is still a young project. There are plans to extend its use. Currently it uses R6
classes for its low-level interface to the OSV API. Pagination functionality will be added
once it is offered by {httr2}, which at time of writing is available but experimental.
There are also plans to have more types of returned details and parsing of content.
{rosv} leverages {httr2} and {httrtest2} for its core API client functionality and
uses R6 classes for its low-level interface to the OSV API. There are also plans to have more
types of returned details and parsing of content.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ repositories across various open source ecosystems such as CRAN,
Bioconductor, PyPI, and many more. Queries made against the OSV database
are useful to check for package vulnerabilities (including by specific
versions) enumerated in package management files such as
`requirements.txt` (Python) and `renv.lock` (R).
`requirements.txt` (Python) and `renv.lock` (R). Checking valid query
construction, API response pagination, and parsing content are all
handled by {rosv}.

Various helper functions assist in the administration of [Posit Package
Manager](https://packagemanager.posit.co/client/#/) or similar services.
Expand Down Expand Up @@ -67,8 +69,7 @@ osv_query(c('dask', 'readxl', 'dplyr'),

## Development notes

{rosv} is still a young project. There are plans to extend its use.
Currently it uses R6 classes for its low-level interface to the OSV API.
Pagination functionality will be added once it is offered by {httr2},
which at time of writing is available but experimental. There are also
plans to have more types of returned details and parsing of content.
{rosv} leverages {httr2} and {httrtest2} for its core API client
functionality and uses R6 classes for its low-level interface to the OSV
API. There are also plans to have more types of returned details and
parsing of content.

0 comments on commit bf100c0

Please # to comment.