Closed owenlittlejohns closed 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)
Jira Issue ID
N/A
Description
I was in the Snyk UI and spotted
harmony-py
has a critical vulnerability inrequirements/example.txt
. This PR addresses the vulnerability by updating the dependencies for the notebooks in theexamples
directory. I also bumped the requirements inrequirements/docs.txt
, as there was a medium severity vulnerability there (tornado
vianbconvert
).I checked things still worked by running the notebooks in the
examples
directory. Most ran, but there were a couple of exceptions:job_stac.ipynb
couldn't findpystac.STAC_IO
, so I changed that topystac.stac_io
, which seemed to work.helper.show_results
inbasics.ipynb
failed for a bunch of requests that were getting NetCDF-4 files out of HGA. I fixed this by forcing all the requests to give GeoTIFF outputs.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
:requirements/example.txt
.jupyter lab
).examples
directory. Checkingbasics.ipynb
is probably a good one, as it uses a lot of the functionality. Similiarly, thejob_stac.ipynb
is a good test ofpystac
andintake-stac
.For
requirements/docs.txt
:requirements/docs.txt
.docs
directory.make html
- this should complete successfully.docs/_build/html/index.html
file in a browser. It should look like some shiny Sphinx-generated documentation.PR Acceptance Checklist
Acceptance criteria metN/ATests added/updated (if needed) and passingN/A