nasa / harmony-py

Python client library for working with NASA’s Earth observing system data using Harmony. https://harmony.earthdata.nasa.gov
Other
50 stars 20 forks source link

Update Snyk vulnerabilities in documentation #74

Closed owenlittlejohns closed 1 year ago

owenlittlejohns commented 1 year ago

Jira Issue ID

N/A

Description

I was in the Snyk UI and spotted harmony-py has a critical vulnerability in requirements/example.txt. This PR addresses the vulnerability by updating the dependencies for the notebooks in the examples directory. I also bumped the requirements in requirements/docs.txt, as there was a medium severity vulnerability there (tornado via nbconvert).

I checked things still worked by running the notebooks in the examples directory. Most ran, but there were a couple of exceptions:

For the Sphinx documentation I had to tweak a method documentation string to make it all run again.

Local Test Steps

For requirements/examples.txt:

For requirements/docs.txt:

PR Acceptance Checklist

owenlittlejohns commented 1 year ago

Quick update - I was getting failing builds because I updated the progressbar2 dependency in requirements/docs.txt, but another version was present in requirements/core.txt. I've updated both places, and verified the tests still pass (locally at least)