From ee0a9e5212b90732a8eab58095a81f3fee02c845 Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Tue, 28 May 2024 14:37:25 -0400 Subject: [PATCH 01/10] recategorize changes into "Common Changelog" groups, format headings, and use imperative mood According to --- CHANGELOG.md | 426 +++++++++++++++++++++++++++------------------------ 1 file changed, 229 insertions(+), 197 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index aabad758..219275a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,224 +2,256 @@ ## [Unreleased] -* Changes +### Changed +- [#555](https://github.com/nsidc/earthaccess/issues/555): YAML formatting is + now performed with `yamlfmt` instead of `prettier`. +- [#511](https://github.com/nsidc/earthaccess/issues/511): Replace `print` + calls with `logging` calls where appropriate and add T20 Ruff rule. +- [#508](https://github.com/nsidc/earthaccess/issues/508): Correct and + enhance static type hints for functions and methods that make CMR queries + or handle CMR query results. +- [#562](https://github.com/nsidc/earthaccess/issues/562): The destination + path is now created prior to direct S3 downloads, if it doesn't already + exist. + +### Added +- [#483](https://github.com/nsidc/earthaccess/issues/483): Now using + [Search After](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#search-after) + for collection and granule searches to support deep-paging through large + result sets. +- [#421](https://github.com/nsidc/earthaccess/issues/421): Enable queries to + Earthdata User Acceptance Testing (UAT) system for authenticated accounts. - * [#421](https://github.com/nsidc/earthaccess/issues/421): Removed the +### Removed +- **Breaking:**: [#421](https://github.com/nsidc/earthaccess/issues/421): Remove the `get_user_profile` method and the `email_address` and `profile` attributes from the `Auth` class. Calling the EDL API to get user profile information is not intended for library access and is not necessary for this library's intended use cases. - * [#555](https://github.com/nsidc/earthaccess/issues/555): YAML formatting is - now performed with `yamlfmt` instead of `prettier`. - * [#511](https://github.com/nsidc/earthaccess/issues/511): Replaced `print` - calls with `logging` calls where appropriate and added T20 Ruff rule. -* Enhancements +## [0.9.0] - 2024-02-28 - * [#483](https://github.com/nsidc/earthaccess/issues/483): Now using - [Search After](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#search-after) - for collection and granule searches to support deep-paging through large - result sets. - * [#508](https://github.com/nsidc/earthaccess/issues/508): Corrected and - enhanced static type hints for functions and methods that make CMR queries - or handle CMR query results. - * [#421](https://github.com/nsidc/earthaccess/issues/421): Enabled queries to - Earthdata User Acceptance Testing (UAT) system for authenticated accounts. - * [#562](https://github.com/nsidc/earthaccess/issues/562): The destination - path is now created prior to direct S3 downloads, if it doesn't already - exist. +### Added +- Address #427 by adding parameters to collection query +- Add user-agent in the request to track usage, closes #436 + +### Fixed +- Fix #439 by implementing more trusted domains in the SessionWithRedirection +- Fix #438 by using an authenticated session for hits() -## [v0.9.0] 2024-02-28 - -* Bug fixes: - * fixed #439 by implementing more trusted domains in the SessionWithRedirection - * fixed #438 by using an authenticated session for hits() -* Enhancements: - * addressing #427 by adding parameters to collection query - * added user-agent in the request to track usage, closes #436 - -## [v0.8.2] 2023-12-06 -* Bug fixes: - * Enable AWS check with IMDSv2 - * Add region to running in AWS check - * Handle opening multi-file granules -* Maintenance: - * Add CI tests with minimum supported versions - * Update poetry lockfile - * Add `python-dateutil` as a direct dependency - * Remove binder PR comments - * Add YAML formatting (prettier) - -## [v0.8.1] 2023-12-01 -* New Features: - * Add `kerchunk` metadata consolidation utility. -* Enhancements: - * Handle S3 credential expiration more gracefully. -* Maintenanece: - * Use dependabot to update Github Actions. - * Consolidate dependabot updates. - * Switch to `ruff` for formatting. - -## [v0.8.0] 2023-11-29 -* Bug fixes: - * Fix zero granules being reported for restricted datasets. -* Enhancements: - * earthaccess will `raise` errors instead of `print`ing them in more cases. - * `daac` and `provider` parameters are now normalized to uppercase, since lowercase +## [0.8.2] - 2023-12-06 + +### Changed +- Update poetry lockfile +- Use YAML formatting (prettier) + +### Added +- Add CI tests with minimum supported versions +- Add `python-dateutil` as a direct dependency + +### Removed +- Remove binder PR comments + +### Fixed +- Enable AWS check with IMDSv2 +- Add region to running in AWS check +- Handle opening multi-file granules + +## [0.8.1] - 2023-12-01 + +### Changed +- Handle S3 credential expiration more gracefully. +- Use dependabot to update Github Actions. +- Consolidate dependabot updates. +- Switch to `ruff` for formatting. + +### Added +- Add `kerchunk` metadata consolidation utility. + +## [0.8.0] - 2023-11-29 + +### Changed +- earthaccess will `raise` errors instead of `print`ing them in more cases. +- `daac` and `provider` parameters are now normalized to uppercase, since lowercase characters are never valid. -## [v0.7.1] 2023-11-08 -* Bug Fixes: - * Treat granules without `RelatedUrls` as not cloud-hosted. +### Fixed +- Fix zero granules being reported for restricted datasets. -## [v0.7.0] 2023-10-31 -* Bug Fixes: - * Fix spelling mistake in `access` variable assignment (`direc` -> `direct`) - in `earthaccess.store._get_granules`. - * Pass `threads` arg to `_open_urls_https` in - `earthaccess.store._open_urls`, replacing the hard-coded value of 8. - * Return S3 data links by default when in region. -* Enhancements: - * `earthaccess.download` now accepts a single granule as input in addition to a list of granules. - * `earthaccess.download` now returns fully qualified local file paths. -* New Features: - * Earthaccess will now automatically search for Earthdata authentication. ``earthaccess.login()`` +## [0.7.1] - 2023-11-08 + +### Fixed +- Treat granules without `RelatedUrls` as not cloud-hosted. + +## [0.7.0] - 2023-10-31 + +### Changed +- `earthaccess.download` now accepts a single granule as input in addition to a list of granules. +- `earthaccess.download` now returns fully qualified local file paths. + +### Added +- Earthaccess will now automatically search for Earthdata authentication. ``earthaccess.login()`` still works as before, but is no longer required if you have a ``~/.netrc`` file for have set ``EARTHDATA_USERNAME`` and ``EARTHDATA_PASSWORD`` environment variables. - * Add `earthaccess.auth_environ()` utility for getting Earthdata authentication environment variables. - -## [v0.6.0] 2023-09-20 -* bug fixes: - * earthaccess.search_datasets() and earthaccess.search_data() can find restricted datasets #296 - * distributed serialization fixed for EarthAccessFile #301 and #276 -* new features: - * earthaccess.get_s3fs_session() can use the results to find the right set of S3 credentials - -## [v0.5.3] 2023-08-01 -* bug fixes: - * granule's size() returned zero - * Added exception handling for fsspec sessions, thanks to @jrbourbeau -* CI changes: - * integration tests are now only run when we push to main (after a merge) - * unit tests run for any branch and opened PR - -## [v0.5.2] 2023-04-21 -* bug fixes: - * Fixing #230 by removing Benedict as the dict handler, thanks to @psarka! - * S3 credential endpoints are tried with tokens and basic auth until all the DAACs accept the same auth - -* Core dependencies: - * Removed Benedict as the default dict for JSON coming from CMR. - -## [v0.5.1] 2023-03-20 - -* bug fixes: - * get_s3_credentials() only worked when a netrc file was present, bug reported by @scottyhq and @JessicaS11 - * including tests for all DAAC S3 endpoints - * Notebooks updated to use the new top level API - * removed magic from dependencies (not available in windows and not used but just in tests) - -* CI changes: - * documentation for readthedocs fixed by including poetry as the default tool - * injected new secrets to test Auth using the icepyx convention (EARTHDATA_USERNAME) -* New Features - * we can get the user's profile with auth.user_profile which includes the user email - * added LAAD as a supported DAAC -## [v0.5.0] 2023-02-23 - -* bug fixes: - * @JessicaS11 fixed a bug where the Auth class was invoked without the proper parameters - * if a user specifies the netrc strategy and there is no netrc an exception is raised - * S3 URLs broke the Store class when opened outside AWS - * Opening files using URLs was not working properly on AWS, thanks to @amfriesz for reporting it! -* CI changes: - * documentation is now only built for the main, dev and documentation branches - * noteboks are executed every time the documentation gets published! -* New features: - * we can now use the top level API to get S3 credentials, authenticated fsspec and requests sessions! - * ASF direct access for Sentinel1 products is now available - -## [v0.4.7] 2022-12-11 - -* bug fixes: - * fixed open() for direct access - * python-magic is a test dependency so moved to the dev section. - * Minor edits in the README - -## [v0.4.6] 2022-12-08 - -* Features: - * search collections by DOI - * new API documentation and simplified notation to access data -* CI changes: - * only run the publish workflow after a release on github - -## [v0.4.1] 2022-11-02 - -* improved documentation: - * reimplemented python_cmr methods for docstring compatibility - * added types to method signatures -* Using `CMR-Search-After` see #145 - -* CI changes: - * Poetry is installed using the new script - * Dependabot alerts to monthly - -* Added GES_DISC S3 endpoint - -## [v0.4.0] 2022-08-17 - -* `store` - * uses fsspec s3fs for in cloud access and https sessions for out of region access - * we can open files with fsspec in and out of region (stream into xarray) -* `auth` - * we can persist our credentials into a `.netrc` file - -* Documentation - * added store, auth to docs and updated mkdocs congif - - -## [v0.3.0] 2022-04-28 - -- Fixed bug with CMR tokens -- dropped python 3.7 support -- updated python-cmr to NASA fork -- added documentation for readthedocs and github -- verifying git tag and poetry version are the same before publish to pypi +- Add `earthaccess.auth_environ()` utility for getting Earthdata authentication environment variables. + +### Fixed +- Fix spelling mistake in `access` variable assignment (`direc` -> `direct`) + in `earthaccess.store._get_granules`. +- Pass `threads` arg to `_open_urls_https` in + `earthaccess.store._open_urls`, replacing the hard-coded value of 8. +- Return S3 data links by default when in region. + +## [0.6.0] - 2023-09-20 + +### Added +- earthaccess.get_s3fs_session() can use the results to find the right set of S3 credentials + +### Fixed +- earthaccess.search_datasets() and earthaccess.search_data() can find restricted datasets #296 +- distributed serialization fixed for EarthAccessFile #301 and #276 + +## [0.5.3] - 2023-08-01 + +### Changed +- For CI, integration tests are now only run when we push to main (after a merge) +- For CI, unit tests are run for any branch and opened PR + +### Fixed +- granule's size() returned zero +- Add exception handling for fsspec sessions, thanks to @jrbourbeau + +## [0.5.2] - 2023-04-21 + +### Removed +- Remove Benedict (core dependency) as the default dict for JSON coming from CMR. + +### Fixed +- Fix #230 by removing Benedict as the dict handler, thanks to @psarka! +- S3 credential endpoints are tried with tokens and basic auth until all the DAACs accept the same auth + +## [0.5.1] - 2023-03-20 + +### Changed +- For CI, documentation for readthedocs fixed by including poetry as the default tool +- For CI, injected new secrets to test Auth using the icepyx convention (EARTHDATA_USERNAME) + +### Added +- Add ability to get the user's profile with auth.user_profile which includes the user email +- Add LAAD as a supported DAAC + +### Fixed +- get_s3_credentials() only worked when a netrc file was present, bug reported by @scottyhq and @JessicaS11 +- including tests for all DAAC S3 endpoints +- Notebooks updated to use the new top level API +- removed magic from dependencies (not available in windows and not used but just in tests) + +## [0.5.0] - 2023-02-23 + +### Changed +- For CI, documentation is now only built for the main, dev and documentation branches +- For CI, noteboks are executed every time the documentation gets published! + +### Added +- Add ability to use the top level API to get S3 credentials, authenticated fsspec and requests sessions! +- Make available ASF direct access for Sentinel1 products + +### Fixed +- @JessicaS11 fixed a bug where the Auth class was invoked without the proper parameters +- if a user specifies the netrc strategy and there is no netrc an exception is raised +- S3 URLs broke the Store class when opened outside AWS +- Opening files using URLs was not working properly on AWS, thanks to @amfriesz for reporting it! + +## [0.4.7] - 2022-12-11 + +### Fixed +- Fix open() for direct access +- Move python-magic to the dev section because it is a test dependency +- Make minor edits in the README + +## [0.4.6] - 2022-12-08 + +### Changed +- For CI, only run the publish workflow after a release on GitHub + +### Added +- Add feature to search collections by DOI +- Add new API documentation and simplify notation to access data + +## [0.4.1] - 2022-11-02 + +### Changed +- For CI, install Poetry using the new script +- For CI, change dependabot alerts to monthly +- Improve documentation by reimplementing python_cmr methods for docstring compatibility +- Use `CMR-Search-After` see #145 + +### Added +- Add GES_DISC S3 endpoint +- Improve documentation by adding types to method signatures + +## [0.4.0] - 2022-08-17 + +### Added +- Add store, auth to docs and update mkdocs congif +- For `auth`, add ability to persist credentials into a `.netrc` file +- For `store`, use fsspec s3fs for in cloud access and https sessions for out of region access +- For `store`, can open files with fsspec in and out of region (stream into xarray) + +## [0.3.0] - 2022-04-28 + +### Changed +- Update python-cmr to NASA fork +- Drop unused `pydantic` dependency - Auth can refresh CMR tokens -- Dropped unused `pydantic` dependency -- Added missing `python-datutil` dependency +- Verify git tag and poetry version are the same before publish to pypi + +### Added +- Add documentation for readthedocs and GitHub + +### Removed +- **Breaking**: Dropped python 3.7 support -## [v0.2.2] 2022-03-23 -- Bug fixes to store to download multi-file granules +### Fixed +- Fix bug with CMR tokens +- Add missing `python-datutil` dependency + +## [0.2.2] - 2022-03-23 + +### Fixed +- Fix store to download multi-file granules - Fix granule formatting -## [v0.2.1] 2022-03-19 -- Renamed Accessor to Store -- relaxed dependency requirements +## [0.2.1] - 2022-03-19 + +### Changed +- Rename Accessor to Store +- Relax dependency requirements - Store can download plain links if they are on prem -## [v0.1.0-beta.1] - 2021-09-21 +## [0.1.0-beta.1] - 2021-09-21 + +_Conception!_ -- Conception! +### Added - Add basic classes to interact with NASA CMR, EDL and cloud access. - Basic object formatting. [Unreleased]: https://github.com/nsidc/earthaccess/compare/v0.9.0...HEAD -[v0.8.2]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.2 -[v0.8.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.1 -[v0.8.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.0 -[v0.7.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.7.1 -[v0.7.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.7.0 -[v0.6.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.6.0 -[v0.5.3]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.3 -[v0.5.2]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.2 -[v0.5.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.1 -[v0.5.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.0 -[v0.4.7]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.7 -[v0.4.6]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.6 -[v0.4.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.1 -[v0.3.0]: https://github.com/betolink/earthaccess/releases/tag/v0.3.0 -[v0.2.2]: https://github.com/betolink/earthaccess/releases/tag/v0.2.2 -[v0.2.1]: https://github.com/betolink/earthaccess/releases/tag/v0.2.1 -[v0.1.0-beta.1]: https://github.com/betolink/earthaccess/releases/tag/v0.1.0-beta.1 +[0.8.2]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.2 +[0.8.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.1 +[0.8.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.0 +[0.7.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.7.1 +[0.7.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.7.0 +[0.6.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.6.0 +[0.5.3]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.3 +[0.5.2]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.2 +[0.5.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.1 +[0.5.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.0 +[0.4.7]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.7 +[0.4.6]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.6 +[0.4.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.1 +[0.3.0]: https://github.com/betolink/earthaccess/releases/tag/v0.3.0 +[0.2.2]: https://github.com/betolink/earthaccess/releases/tag/v0.2.2 +[0.2.1]: https://github.com/betolink/earthaccess/releases/tag/v0.2.1 +[0.1.0-beta.1]: https://github.com/betolink/earthaccess/releases/tag/v0.1.0-beta.1 From 7fba5a3edc06e96749a7c96a18ca4c15a413ae48 Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Wed, 29 May 2024 12:26:33 -0400 Subject: [PATCH 02/10] typo --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 219275a6..8ed932bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,7 @@ Earthdata User Acceptance Testing (UAT) system for authenticated accounts. ### Removed -- **Breaking:**: [#421](https://github.com/nsidc/earthaccess/issues/421): Remove the +- **Breaking**: [#421](https://github.com/nsidc/earthaccess/issues/421): Remove the `get_user_profile` method and the `email_address` and `profile` attributes from the `Auth` class. Calling the EDL API to get user profile information is not intended for library access and is not necessary for this library's @@ -150,7 +150,7 @@ ### Changed - For CI, documentation is now only built for the main, dev and documentation branches -- For CI, noteboks are executed every time the documentation gets published! +- For CI, notebooks are executed every time the documentation gets published! ### Added - Add ability to use the top level API to get S3 credentials, authenticated fsspec and requests sessions! @@ -193,8 +193,8 @@ ## [0.4.0] - 2022-08-17 ### Added -- Add store, auth to docs and update mkdocs congif -- For `auth`, add ability to persist credentials into a `.netrc` file +- Add store, auth to docs and update mkdocs config +- For `auth`, add the ability to persist credentials into a `.netrc` file - For `store`, use fsspec s3fs for in cloud access and https sessions for out of region access - For `store`, can open files with fsspec in and out of region (stream into xarray) From c148a081c58ede5b56a7aab31fa4a19e630d3c04 Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Fri, 5 Jul 2024 18:04:32 -0400 Subject: [PATCH 03/10] add links to issues/PRs/commits and authors for changelog entries (in-progress, about half-way through) --- CHANGELOG.md | 90 ++++++++++++++++++++++++++-------------------------- 1 file changed, 45 insertions(+), 45 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ed932bc..3564d2ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -61,7 +61,7 @@ ### Changed - Handle S3 credential expiration more gracefully. -- Use dependabot to update Github Actions. +- Use dependabot to update GitHub Actions. - Consolidate dependabot updates. - Switch to `ruff` for formatting. @@ -133,101 +133,101 @@ ## [0.5.1] - 2023-03-20 ### Changed -- For CI, documentation for readthedocs fixed by including poetry as the default tool -- For CI, injected new secrets to test Auth using the icepyx convention (EARTHDATA_USERNAME) +- For CI, documentation for readthedocs fixed by including poetry as the default tool ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) +- For CI, injected new secrets to test Auth using the icepyx convention (EARTHDATA_USERNAME) ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@JessicaS11**](https://github.com/JessicaS11), [**@betolink**](https://github.com/betolink)) ### Added -- Add ability to get the user's profile with auth.user_profile which includes the user email -- Add LAAD as a supported DAAC +- Add ability to get the user's profile with auth.user_profile which includes the user email ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) +- Add LAAD as a supported DAAC ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) ### Fixed -- get_s3_credentials() only worked when a netrc file was present, bug reported by @scottyhq and @JessicaS11 -- including tests for all DAAC S3 endpoints -- Notebooks updated to use the new top level API -- removed magic from dependencies (not available in windows and not used but just in tests) +- get_s3_credentials() only worked when a netrc file was present, bug reported by @scottyhq and @JessicaS11 ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink), [**@JessicaS11**](https://github.com/JessicaS11), [**@scottyhq**](https://github.com/scottyhq)) +- including tests for all DAAC S3 endpoints ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) +- Notebooks updated to use the new top level API ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) +- removed magic from dependencies (not available in windows and not used but just in tests) ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) ## [0.5.0] - 2023-02-23 ### Changed -- For CI, documentation is now only built for the main, dev and documentation branches -- For CI, notebooks are executed every time the documentation gets published! +- For CI, documentation is now only built for the main, dev and documentation branches ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) +- For CI, notebooks are executed every time the documentation gets published! ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink), [**@asteiker**](https://github.com/asteiker)) ### Added -- Add ability to use the top level API to get S3 credentials, authenticated fsspec and requests sessions! -- Make available ASF direct access for Sentinel1 products +- Add ability to use the top level API to get S3 credentials, authenticated fsspec and requests sessions! ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) +- Make available ASF direct access for Sentinel1 products ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) ### Fixed -- @JessicaS11 fixed a bug where the Auth class was invoked without the proper parameters -- if a user specifies the netrc strategy and there is no netrc an exception is raised -- S3 URLs broke the Store class when opened outside AWS -- Opening files using URLs was not working properly on AWS, thanks to @amfriesz for reporting it! +- Fix a bug where the Auth class is invoked without the proper parameters ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@JessicaS11**](https://github.com/JessicaS11)) +- if a user specifies the netrc strategy and there is no netrc an exception is raised ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) +- S3 URLs broke the Store class when opened outside AWS ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) +- Opening files using URLs was not working properly on AWS, thanks to @amfriesz for reporting it! ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink), ([**@amfriesz**](https://github.com/amfriesz))) ## [0.4.7] - 2022-12-11 ### Fixed -- Fix open() for direct access -- Move python-magic to the dev section because it is a test dependency -- Make minor edits in the README +- Fix open() for direct access ([#186](https://github.com/nsidc/earthaccess/pull/186))([**@betolink**](https://github.com/betolink)) +- Move python-magic to the dev section because it is a test dependency ([#186](https://github.com/nsidc/earthaccess/pull/186))([**@betolink**](https://github.com/betolink)) +- Make minor edits in the README ([#186](https://github.com/nsidc/earthaccess/pull/186))([**@betolink**](https://github.com/betolink)) ## [0.4.6] - 2022-12-08 ### Changed -- For CI, only run the publish workflow after a release on GitHub +- For CI, only run the publish workflow after a release on GitHub ([#183](https://github.com/nsidc/earthaccess/pull/183))([**@betolink**](https://github.com/betolink)) ### Added -- Add feature to search collections by DOI -- Add new API documentation and simplify notation to access data +- Add feature to search collections by DOI ([#183](https://github.com/nsidc/earthaccess/pull/183))([**@betolink**](https://github.com/betolink)) +- Add new API documentation and simplify notation to access data ([#183](https://github.com/nsidc/earthaccess/pull/183)) ([**@jroebuck932**](https://github.com/jroebuck932)) ## [0.4.1] - 2022-11-02 ### Changed -- For CI, install Poetry using the new script -- For CI, change dependabot alerts to monthly -- Improve documentation by reimplementing python_cmr methods for docstring compatibility -- Use `CMR-Search-After` see #145 +- For CI, install Poetry using the new script ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) +- For CI, change dependabot alerts to monthly ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) +- Improve documentation by reimplementing python_cmr methods for docstring compatibility ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) +- Use `CMR-Search-After` see #145 ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) ### Added -- Add GES_DISC S3 endpoint -- Improve documentation by adding types to method signatures +- Add GES_DISC S3 endpoint ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) +- Improve documentation by adding types to method signatures ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) ## [0.4.0] - 2022-08-17 ### Added -- Add store, auth to docs and update mkdocs config -- For `auth`, add the ability to persist credentials into a `.netrc` file -- For `store`, use fsspec s3fs for in cloud access and https sessions for out of region access -- For `store`, can open files with fsspec in and out of region (stream into xarray) +- Add store, auth to docs and update mkdocs config ([#119](https://github.com/nsidc/earthaccess/pull/119))([**@betolink**](https://github.com/betolink)) +- For `auth`, add the ability to persist credentials into a `.netrc` file ([#119](https://github.com/nsidc/earthaccess/pull/119))([**@betolink**](https://github.com/betolink)) +- For `store`, use fsspec s3fs for in cloud access and https sessions for out of region access ([#43](https://github.com/nsidc/earthaccess/issues/43))([**@betolink**](https://github.com/betolink)) +- For `store`, can open files with fsspec in and out of region (stream into xarray) ([#41](https://github.com/nsidc/earthaccess/issues/41))([**@betolink**](https://github.com/betolink)) ## [0.3.0] - 2022-04-28 ### Changed -- Update python-cmr to NASA fork -- Drop unused `pydantic` dependency -- Auth can refresh CMR tokens -- Verify git tag and poetry version are the same before publish to pypi +- Update python-cmr to NASA fork ([#75](https://github.com/nsidc/earthaccess/pull/75))([**@jhkennedy**](https://github.com/jhkennedy)) +- Drop unused `pydantic` dependency ([`5761548`](https://github.com/nsidc/earthaccess/pull/75/commits/5761548fcd8ba8733ce4f5ff9b8ce7967c3a8398))([**@jhkennedy**](https://github.com/jhkennedy)) +- Auth can refresh CMR tokens ([#82](https://github.com/nsidc/earthaccess/pull/82))([**@betolink**](https://github.com/betolink)) +- Verify git tag and poetry version are the same before publishing to PyPI ### Added -- Add documentation for readthedocs and GitHub +- Add documentation for readthedocs and GitHub ([#82](https://github.com/nsidc/earthaccess/pull/82))([**@betolink**](https://github.com/betolink)) ### Removed -- **Breaking**: Dropped python 3.7 support +- **Breaking**: Drop python 3.7 support ([#82](https://github.com/nsidc/earthaccess/pull/82))([**@betolink**](https://github.com/betolink)) ### Fixed - Fix bug with CMR tokens -- Add missing `python-datutil` dependency +- Add missing `python-datutil` dependency ([`747e992`](https://github.com/nsidc/earthaccess/pull/75/commits/747e9926a5ab83d75bbf7f17d4c52f24b563147b))([**@jhkennedy**](https://github.com/jhkennedy)) ## [0.2.2] - 2022-03-23 ### Fixed -- Fix store to download multi-file granules -- Fix granule formatting +- Fix store to download multi-file granules ([#73](https://github.com/nsidc/earthaccess/pull/73))([**@betolink**](https://github.com/betolink)) +- Fix granule formatting ([#73](https://github.com/nsidc/earthaccess/pull/73))([**@betolink**](https://github.com/betolink)) ## [0.2.1] - 2022-03-19 ### Changed -- Rename Accessor to Store -- Relax dependency requirements -- Store can download plain links if they are on prem +- Rename Accessor to Store ([`4bd618d`](https://github.com/nsidc/earthaccess/pull/66/commits/4bd618d4d48c3cd256a077fb8329f40df2d5b7ff))([**@betolink**](https://github.com/betolink)) +- Relax dependency requirements ([`c9a5ed6`](https://github.com/nsidc/earthaccess/pull/66/commits/c9a5ed6b917435e7c4ece58485939065fa71cc8f))([**@betolink**](https://github.com/betolink)) +- Store can download plain links if they are on prem ([`92d2919`](https://github.com/nsidc/earthaccess/commit/92d291962e5b72b458c2971eae8a6b813d4bae39))([**@betolink**](https://github.com/betolink)) ## [0.1.0-beta.1] - 2021-09-21 From b4e4beb4206b6f8dd5982040ad3fa2f4df77aaba Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Mon, 8 Jul 2024 12:25:05 -0400 Subject: [PATCH 04/10] consolidate redundant entry --- CHANGELOG.md | 70 +++++++++++++++++++++++++++------------------------- 1 file changed, 36 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3564d2ba..675db999 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -42,93 +42,95 @@ ## [0.8.2] - 2023-12-06 ### Changed -- Update poetry lockfile -- Use YAML formatting (prettier) +- Update poetry lockfile ([#403](https://github.com/nsidc/earthaccess/pull/403))([**@jrbourbeau**](https://github.com/jrbourbeau)) +- Use YAML formatting (prettier) ([#398](https://github.com/nsidc/earthaccess/pull/398))([**@jrbourbeau**](https://github.com/jrbourbeau)) ### Added -- Add CI tests with minimum supported versions -- Add `python-dateutil` as a direct dependency +- Add CI tests with minimum supported versions ([#402](https://github.com/nsidc/earthaccess/pull/402))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), [**@jhkennedy**](https://github.com/jhkennedy)) +- Add `python-dateutil` as a direct dependency ([#397](https://github.com/nsidc/earthaccess/pull/397))([**@jrbourbeau**](https://github.com/jrbourbeau)) ### Removed -- Remove binder PR comments +- Remove binder PR comments ([#400](https://github.com/nsidc/earthaccess/pull/400))([**@jrbourbeau**](https://github.com/jrbourbeau)) ### Fixed -- Enable AWS check with IMDSv2 -- Add region to running in AWS check -- Handle opening multi-file granules +- Enable AWS check with IMDSv2 ([#391](https://github.com/nsidc/earthaccess/pull/391))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), [**@itcarroll**](https://github.com/itcarroll)) +- Add region to running in AWS check ([#395](https://github.com/nsidc/earthaccess/pull/395))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@betolink**](https://github.com/betolink)) +- Handle opening multi-file granules ([#394](https://github.com/nsidc/earthaccess/pull/394))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@betolink**](https://github.com/betolink)) ## [0.8.1] - 2023-12-01 ### Changed -- Handle S3 credential expiration more gracefully. -- Use dependabot to update GitHub Actions. -- Consolidate dependabot updates. -- Switch to `ruff` for formatting. +- Handle S3 credential expiration more gracefully ([#354](https://github.com/nsidc/earthaccess/pull/354))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) +- Use dependabot to update GitHub Actions ([#373](https://github.com/nsidc/earthaccess/pull/373))([**@jhkennedy**](https://github.com/jhkennedy)) +- Consolidate dependabot updates ([#380](https://github.com/nsidc/earthaccess/pull/380))([**@mfisher87**](https://github.com/mfisher87)) +- Switch to `ruff` for formatting ([#372](https://github.com/nsidc/earthaccess/pull/372))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) ### Added -- Add `kerchunk` metadata consolidation utility. +- Add `kerchunk` metadata consolidation utility ([#278](https://github.com/nsidc/earthaccess/pull/278)) + ([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), + [**@betolink**](https://github.com/betolink), [**@martindurant**](https://github.com/martindurant), + [**lsterzinger**](https://github.com/lsterzinger), [**mrocklin**](https://github.com/mrocklin)) ## [0.8.0] - 2023-11-29 ### Changed -- earthaccess will `raise` errors instead of `print`ing them in more cases. +- earthaccess will `raise` errors instead of `print`ing them in more cases ([#351](https://github.com/nsidc/earthaccess/pull/351))([**@jrbourbeau**](https://github.com/jrbourbeau)) - `daac` and `provider` parameters are now normalized to uppercase, since lowercase - characters are never valid. + characters are never valid ([#355](https://github.com/nsidc/earthaccess/pull/355))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) ### Fixed -- Fix zero granules being reported for restricted datasets. +- Fix zero granules being reported for restricted datasets ([#358](https://github.com/nsidc/earthaccess/pull/358))([**@danielfromearth**](https://github.com/danielfromearth)) ## [0.7.1] - 2023-11-08 ### Fixed -- Treat granules without `RelatedUrls` as not cloud-hosted. +- Treat granules without `RelatedUrls` as not cloud-hosted ([#339](https://github.com/nsidc/earthaccess/pull/339))([**@mfisher87**](https://github.com/mfisher87)) ## [0.7.0] - 2023-10-31 ### Changed -- `earthaccess.download` now accepts a single granule as input in addition to a list of granules. -- `earthaccess.download` now returns fully qualified local file paths. +- `earthaccess.download` now accepts a single granule as input in addition to a list of granules ([#317](https://github.com/nsidc/earthaccess/pull/317))([**@jrbourbeau**](https://github.com/jrbourbeau)) +- `earthaccess.download` now returns fully qualified local file paths ([#317](https://github.com/nsidc/earthaccess/pull/317))([**@jrbourbeau**](https://github.com/jrbourbeau)) ### Added - Earthaccess will now automatically search for Earthdata authentication. ``earthaccess.login()`` still works as before, but is no longer required if you have a ``~/.netrc`` file for have set - ``EARTHDATA_USERNAME`` and ``EARTHDATA_PASSWORD`` environment variables. -- Add `earthaccess.auth_environ()` utility for getting Earthdata authentication environment variables. + ``EARTHDATA_USERNAME`` and ``EARTHDATA_PASSWORD`` environment variables ([#300](https://github.com/nsidc/earthaccess/pull/300))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), [**@mfisher87**](https://github.com/mfisher87)) +- Add `earthaccess.auth_environ()` utility for getting Earthdata authentication environment variables ([#316](https://github.com/nsidc/earthaccess/pull/316))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) ### Fixed - Fix spelling mistake in `access` variable assignment (`direc` -> `direct`) - in `earthaccess.store._get_granules`. + in `earthaccess.store._get_granules` ([#308](https://github.com/nsidc/earthaccess/pull/308))([**@trey-stafford**](https://github.com/trey-stafford)) - Pass `threads` arg to `_open_urls_https` in - `earthaccess.store._open_urls`, replacing the hard-coded value of 8. -- Return S3 data links by default when in region. + `earthaccess.store._open_urls`, replacing the hard-coded value of 8 ([#308](https://github.com/nsidc/earthaccess/pull/308))([**@trey-stafford**](https://github.com/trey-stafford)) +- Return S3 data links by default when in region ([#318](https://github.com/nsidc/earthaccess/pull/318))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), [**@jhkennedy**](https://github.com/jhkennedy)) ## [0.6.0] - 2023-09-20 ### Added -- earthaccess.get_s3fs_session() can use the results to find the right set of S3 credentials +- earthaccess.get_s3fs_session() can use the results to find the right set of S3 credentials ([#296](https://github.com/nsidc/earthaccess/pull/296))([**@betolink**](https://github.com/betolink)) ### Fixed -- earthaccess.search_datasets() and earthaccess.search_data() can find restricted datasets #296 -- distributed serialization fixed for EarthAccessFile #301 and #276 +- earthaccess.search_datasets() and earthaccess.search_data() can find restricted datasets ([#296](https://github.com/nsidc/earthaccess/pull/296))([**@betolink**](https://github.com/betolink)) +- Fix distributed serialization for EarthAccessFile ([#301](https://github.com/nsidc/earthaccess/pull/301))([**@jrbourbeau**](https://github.com/jrbourbeau)) and ([#276](https://github.com/nsidc/earthaccess/pull/276))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@betolink**](https://github.com/betolink)) ## [0.5.3] - 2023-08-01 ### Changed -- For CI, integration tests are now only run when we push to main (after a merge) -- For CI, unit tests are run for any branch and opened PR +- For CI, integration tests are now only run when we push to main (after a merge) ([#267](https://github.com/nsidc/earthaccess/pull/267))([**@betolink**](https://github.com/betolink)) +- For CI, unit tests are run for any branch and opened PR ([#267](https://github.com/nsidc/earthaccess/pull/267))([**@betolink**](https://github.com/betolink)) ### Fixed -- granule's size() returned zero -- Add exception handling for fsspec sessions, thanks to @jrbourbeau +- Granule's size() returned zero ([#267](https://github.com/nsidc/earthaccess/pull/267))([**@betolink**](https://github.com/betolink)) +- Add exception handling for fsspec sessions, thanks to @jrbourbeau ([#249](https://github.com/nsidc/earthaccess/pull/249))([**@jrbourbeau**](https://github.com/jrbourbeau)) ## [0.5.2] - 2023-04-21 ### Removed -- Remove Benedict (core dependency) as the default dict for JSON coming from CMR. +- Remove Benedict (core dependency) as the default dict for JSON coming from CMR ([#229](https://github.com/nsidc/earthaccess/pull/229), [#230](https://github.com/nsidc/earthaccess/issues/230))([**@psarka**](https://github.com/psarka)) ### Fixed -- Fix #230 by removing Benedict as the dict handler, thanks to @psarka! -- S3 credential endpoints are tried with tokens and basic auth until all the DAACs accept the same auth +- S3 credential endpoints are tried with tokens and basic auth until all the DAACs accept the same auth ([#234](https://github.com/nsidc/earthaccess/pull/234))([**@betolink**](https://github.com/betolink)) ## [0.5.1] - 2023-03-20 From b4613a1aac75b71334847bb7f35d1be5aee81847 Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Mon, 8 Jul 2024 13:00:13 -0400 Subject: [PATCH 05/10] Add and update remaining links to issues/PRs/commits in the CHANGELOG.md --- CHANGELOG.md | 77 ++++++++++++++++++++++++++++++++-------------------- 1 file changed, 48 insertions(+), 29 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 675db999..ececce3a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,41 +3,58 @@ ## [Unreleased] ### Changed -- [#555](https://github.com/nsidc/earthaccess/issues/555): YAML formatting is - now performed with `yamlfmt` instead of `prettier`. -- [#511](https://github.com/nsidc/earthaccess/issues/511): Replace `print` - calls with `logging` calls where appropriate and add T20 Ruff rule. -- [#508](https://github.com/nsidc/earthaccess/issues/508): Correct and - enhance static type hints for functions and methods that make CMR queries - or handle CMR query results. -- [#562](https://github.com/nsidc/earthaccess/issues/562): The destination - path is now created prior to direct S3 downloads, if it doesn't already - exist. +- Perform YAML formatting with `yamlfmt` instead of + `prettier` ([#555](https://github.com/nsidc/earthaccess/issues/555)) + ([**@chuckwondo**](https://github.com/chuckwondo),[**@mfisher87**](https://github.com/mfisher87)) +- Replace `print` calls with `logging` calls where appropriate and add T20 Ruff rule + ([#511](https://github.com/nsidc/earthaccess/issues/511)) + ([**@botanical**](https://github.com/botanical),[**@chuckwondo**](https://github.com/chuckwondo), + [**@mfisher87**](https://github.com/mfisher87)) +- Correct and enhance static type hints for functions and methods that make CMR queries + or handle CMR query results ([#508](https://github.com/nsidc/earthaccess/issues/508)) + ([**@mfisher87**](https://github.com/mfisher87),[**@jhkennedy**](https://github.com/jhkennedy), + [**@chuckwondo**](https://github.com/chuckwondo),[**@betolink**](https://github.com/betolink)) +- Create destination path prior to direct S3 downloads, if it doesn't already + exist ([#562](https://github.com/nsidc/earthaccess/issues/562)) + ([**@itcarroll**](https://github.com/itcarroll),[**@mfisher87**](https://github.com/mfisher87), + [**@chuckwondo**](https://github.com/chuckwondo)) ### Added -- [#483](https://github.com/nsidc/earthaccess/issues/483): Now using - [Search After](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#search-after) - for collection and granule searches to support deep-paging through large - result sets. -- [#421](https://github.com/nsidc/earthaccess/issues/421): Enable queries to - Earthdata User Acceptance Testing (UAT) system for authenticated accounts. +- Use [Search After](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#search-after) + for collection and granule searches to support deep-paging through large result sets + ([#483](https://github.com/nsidc/earthaccess/issues/483)) + ([**@doug-newman-nasa**](https://github.com/doug-newman-nasa),[**@chuckwondo**](https://github.com/chuckwondo), + [**@mfisher87**](https://github.com/mfisher87),[**@betolink**](https://github.com/betolink)) +- Enable queries to Earthdata User Acceptance Testing (UAT) system for authenticated accounts + ([#421](https://github.com/nsidc/earthaccess/issues/421)) + ([**@danielfromearth**](https://github.com/danielfromearth),[**@mfisher87**](https://github.com/mfisher87), + [**@jhkennedy**](https://github.com/jhkennedy),[**@chuckwondo**](https://github.com/chuckwondo), + [**@betolink**](https://github.com/betolink)) ### Removed -- **Breaking**: [#421](https://github.com/nsidc/earthaccess/issues/421): Remove the +- **Breaking:** Remove the `get_user_profile` method and the `email_address` and `profile` attributes from the `Auth` class. Calling the EDL API to get user profile information is not intended for library access and is not necessary for this library's - intended use cases. + intended use cases. ([#421](https://github.com/nsidc/earthaccess/issues/421)) + ([**@danielfromearth**](https://github.com/danielfromearth),[**@mfisher87**](https://github.com/mfisher87), + [**@jhkennedy**](https://github.com/jhkennedy),[**@chuckwondo**](https://github.com/chuckwondo), + [**@betolink**](https://github.com/betolink)) ## [0.9.0] - 2024-02-28 ### Added -- Address #427 by adding parameters to collection query -- Add user-agent in the request to track usage, closes #436 +- Improve search by adding instrument and project to collection queries + ([#427](https://github.com/nsidc/earthaccess/issues/427)) + ([**@betolink**](https://github.com/betolink),[**@mfisher87**](https://github.com/mfisher87), + [**@jhkennedy**](https://github.com/jhkennedy)) +- Add user-agent in the request to track usage ([#436](https://github.com/nsidc/earthaccess/issues/436)) + ([**@asteiker**](https://github.com/asteiker),[**@@mikedorfman**](https://github.com/@mikedorfman), + [**@betolink**](https://github.com/betolink)) ### Fixed -- Fix #439 by implementing more trusted domains in the SessionWithRedirection -- Fix #438 by using an authenticated session for hits() +- Implement more trusted domains in the SessionWithRedirection ([#439](https://github.com/nsidc/earthaccess/issues/439))([**@cmspeed**](https://github.com/cmspeed), [**@mfisher87**](https://github.com/mfisher87), [**@betolink**](https://github.com/betolink), [**@jhkennedy**](https://github.com/jhkennedy)) +- Use an authenticated session for hits() instead of calling parent's class super() ([#438](https://github.com/nsidc/earthaccess/issues/438))([**@betolink**](https://github.com/betolink), [**@mfisher87**](https://github.com/mfisher87), [**@jhkennedy**](https://github.com/jhkennedy)) ## [0.8.2] - 2023-12-06 @@ -108,10 +125,10 @@ ## [0.6.0] - 2023-09-20 ### Added -- earthaccess.get_s3fs_session() can use the results to find the right set of S3 credentials ([#296](https://github.com/nsidc/earthaccess/pull/296))([**@betolink**](https://github.com/betolink)) +- `earthaccess.get_s3fs_session()` can use the results to find the right set of S3 credentials ([#296](https://github.com/nsidc/earthaccess/pull/296))([**@betolink**](https://github.com/betolink)) ### Fixed -- earthaccess.search_datasets() and earthaccess.search_data() can find restricted datasets ([#296](https://github.com/nsidc/earthaccess/pull/296))([**@betolink**](https://github.com/betolink)) +- `earthaccess.search_datasets()` and `earthaccess.search_data()` can find restricted datasets ([#296](https://github.com/nsidc/earthaccess/pull/296))([**@betolink**](https://github.com/betolink)) - Fix distributed serialization for EarthAccessFile ([#301](https://github.com/nsidc/earthaccess/pull/301))([**@jrbourbeau**](https://github.com/jrbourbeau)) and ([#276](https://github.com/nsidc/earthaccess/pull/276))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@betolink**](https://github.com/betolink)) ## [0.5.3] - 2023-08-01 @@ -142,11 +159,13 @@ - Add ability to get the user's profile with auth.user_profile which includes the user email ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) - Add LAAD as a supported DAAC ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) +### Removed +- Remove magic from dependencies (not available in windows and not used but just in tests) ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) + ### Fixed -- get_s3_credentials() only worked when a netrc file was present, bug reported by @scottyhq and @JessicaS11 ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink), [**@JessicaS11**](https://github.com/JessicaS11), [**@scottyhq**](https://github.com/scottyhq)) -- including tests for all DAAC S3 endpoints ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) -- Notebooks updated to use the new top level API ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) -- removed magic from dependencies (not available in windows and not used but just in tests) ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) +- `get_s3_credentials()` only worked when a netrc file was present, bug reported by @scottyhq and @JessicaS11 ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink), [**@JessicaS11**](https://github.com/JessicaS11), [**@scottyhq**](https://github.com/scottyhq)) +- Include tests for all DAAC S3 endpoints ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) +- Update notebooks to use the new top level API ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) ## [0.5.0] - 2023-02-23 @@ -160,7 +179,7 @@ ### Fixed - Fix a bug where the Auth class is invoked without the proper parameters ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@JessicaS11**](https://github.com/JessicaS11)) -- if a user specifies the netrc strategy and there is no netrc an exception is raised ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) +- Raise and exception if a user specifies the netrc strategy and there is no netrc ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) - S3 URLs broke the Store class when opened outside AWS ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) - Opening files using URLs was not working properly on AWS, thanks to @amfriesz for reporting it! ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink), ([**@amfriesz**](https://github.com/amfriesz))) From 8bf7d5eabfba3309cadfc19729afee05efd571d3 Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Mon, 8 Jul 2024 13:01:48 -0400 Subject: [PATCH 06/10] add single blank line after each header --- CHANGELOG.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ececce3a..be67504e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## [Unreleased] ### Changed + - Perform YAML formatting with `yamlfmt` instead of `prettier` ([#555](https://github.com/nsidc/earthaccess/issues/555)) ([**@chuckwondo**](https://github.com/chuckwondo),[**@mfisher87**](https://github.com/mfisher87)) @@ -20,6 +21,7 @@ [**@chuckwondo**](https://github.com/chuckwondo)) ### Added + - Use [Search After](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#search-after) for collection and granule searches to support deep-paging through large result sets ([#483](https://github.com/nsidc/earthaccess/issues/483)) @@ -32,6 +34,7 @@ [**@betolink**](https://github.com/betolink)) ### Removed + - **Breaking:** Remove the `get_user_profile` method and the `email_address` and `profile` attributes from the `Auth` class. Calling the EDL API to get user profile information @@ -44,6 +47,7 @@ ## [0.9.0] - 2024-02-28 ### Added + - Improve search by adding instrument and project to collection queries ([#427](https://github.com/nsidc/earthaccess/issues/427)) ([**@betolink**](https://github.com/betolink),[**@mfisher87**](https://github.com/mfisher87), @@ -53,23 +57,28 @@ [**@betolink**](https://github.com/betolink)) ### Fixed + - Implement more trusted domains in the SessionWithRedirection ([#439](https://github.com/nsidc/earthaccess/issues/439))([**@cmspeed**](https://github.com/cmspeed), [**@mfisher87**](https://github.com/mfisher87), [**@betolink**](https://github.com/betolink), [**@jhkennedy**](https://github.com/jhkennedy)) - Use an authenticated session for hits() instead of calling parent's class super() ([#438](https://github.com/nsidc/earthaccess/issues/438))([**@betolink**](https://github.com/betolink), [**@mfisher87**](https://github.com/mfisher87), [**@jhkennedy**](https://github.com/jhkennedy)) ## [0.8.2] - 2023-12-06 ### Changed + - Update poetry lockfile ([#403](https://github.com/nsidc/earthaccess/pull/403))([**@jrbourbeau**](https://github.com/jrbourbeau)) - Use YAML formatting (prettier) ([#398](https://github.com/nsidc/earthaccess/pull/398))([**@jrbourbeau**](https://github.com/jrbourbeau)) ### Added + - Add CI tests with minimum supported versions ([#402](https://github.com/nsidc/earthaccess/pull/402))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), [**@jhkennedy**](https://github.com/jhkennedy)) - Add `python-dateutil` as a direct dependency ([#397](https://github.com/nsidc/earthaccess/pull/397))([**@jrbourbeau**](https://github.com/jrbourbeau)) ### Removed + - Remove binder PR comments ([#400](https://github.com/nsidc/earthaccess/pull/400))([**@jrbourbeau**](https://github.com/jrbourbeau)) ### Fixed + - Enable AWS check with IMDSv2 ([#391](https://github.com/nsidc/earthaccess/pull/391))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), [**@itcarroll**](https://github.com/itcarroll)) - Add region to running in AWS check ([#395](https://github.com/nsidc/earthaccess/pull/395))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@betolink**](https://github.com/betolink)) - Handle opening multi-file granules ([#394](https://github.com/nsidc/earthaccess/pull/394))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@betolink**](https://github.com/betolink)) @@ -77,12 +86,14 @@ ## [0.8.1] - 2023-12-01 ### Changed + - Handle S3 credential expiration more gracefully ([#354](https://github.com/nsidc/earthaccess/pull/354))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) - Use dependabot to update GitHub Actions ([#373](https://github.com/nsidc/earthaccess/pull/373))([**@jhkennedy**](https://github.com/jhkennedy)) - Consolidate dependabot updates ([#380](https://github.com/nsidc/earthaccess/pull/380))([**@mfisher87**](https://github.com/mfisher87)) - Switch to `ruff` for formatting ([#372](https://github.com/nsidc/earthaccess/pull/372))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) ### Added + - Add `kerchunk` metadata consolidation utility ([#278](https://github.com/nsidc/earthaccess/pull/278)) ([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), [**@betolink**](https://github.com/betolink), [**@martindurant**](https://github.com/martindurant), @@ -91,31 +102,37 @@ ## [0.8.0] - 2023-11-29 ### Changed + - earthaccess will `raise` errors instead of `print`ing them in more cases ([#351](https://github.com/nsidc/earthaccess/pull/351))([**@jrbourbeau**](https://github.com/jrbourbeau)) - `daac` and `provider` parameters are now normalized to uppercase, since lowercase characters are never valid ([#355](https://github.com/nsidc/earthaccess/pull/355))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) ### Fixed + - Fix zero granules being reported for restricted datasets ([#358](https://github.com/nsidc/earthaccess/pull/358))([**@danielfromearth**](https://github.com/danielfromearth)) ## [0.7.1] - 2023-11-08 ### Fixed + - Treat granules without `RelatedUrls` as not cloud-hosted ([#339](https://github.com/nsidc/earthaccess/pull/339))([**@mfisher87**](https://github.com/mfisher87)) ## [0.7.0] - 2023-10-31 ### Changed + - `earthaccess.download` now accepts a single granule as input in addition to a list of granules ([#317](https://github.com/nsidc/earthaccess/pull/317))([**@jrbourbeau**](https://github.com/jrbourbeau)) - `earthaccess.download` now returns fully qualified local file paths ([#317](https://github.com/nsidc/earthaccess/pull/317))([**@jrbourbeau**](https://github.com/jrbourbeau)) ### Added + - Earthaccess will now automatically search for Earthdata authentication. ``earthaccess.login()`` still works as before, but is no longer required if you have a ``~/.netrc`` file for have set ``EARTHDATA_USERNAME`` and ``EARTHDATA_PASSWORD`` environment variables ([#300](https://github.com/nsidc/earthaccess/pull/300))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87), [**@mfisher87**](https://github.com/mfisher87)) - Add `earthaccess.auth_environ()` utility for getting Earthdata authentication environment variables ([#316](https://github.com/nsidc/earthaccess/pull/316))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) ### Fixed + - Fix spelling mistake in `access` variable assignment (`direc` -> `direct`) in `earthaccess.store._get_granules` ([#308](https://github.com/nsidc/earthaccess/pull/308))([**@trey-stafford**](https://github.com/trey-stafford)) - Pass `threads` arg to `_open_urls_https` in @@ -125,44 +142,54 @@ ## [0.6.0] - 2023-09-20 ### Added + - `earthaccess.get_s3fs_session()` can use the results to find the right set of S3 credentials ([#296](https://github.com/nsidc/earthaccess/pull/296))([**@betolink**](https://github.com/betolink)) ### Fixed + - `earthaccess.search_datasets()` and `earthaccess.search_data()` can find restricted datasets ([#296](https://github.com/nsidc/earthaccess/pull/296))([**@betolink**](https://github.com/betolink)) - Fix distributed serialization for EarthAccessFile ([#301](https://github.com/nsidc/earthaccess/pull/301))([**@jrbourbeau**](https://github.com/jrbourbeau)) and ([#276](https://github.com/nsidc/earthaccess/pull/276))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@betolink**](https://github.com/betolink)) ## [0.5.3] - 2023-08-01 ### Changed + - For CI, integration tests are now only run when we push to main (after a merge) ([#267](https://github.com/nsidc/earthaccess/pull/267))([**@betolink**](https://github.com/betolink)) - For CI, unit tests are run for any branch and opened PR ([#267](https://github.com/nsidc/earthaccess/pull/267))([**@betolink**](https://github.com/betolink)) ### Fixed + - Granule's size() returned zero ([#267](https://github.com/nsidc/earthaccess/pull/267))([**@betolink**](https://github.com/betolink)) - Add exception handling for fsspec sessions, thanks to @jrbourbeau ([#249](https://github.com/nsidc/earthaccess/pull/249))([**@jrbourbeau**](https://github.com/jrbourbeau)) ## [0.5.2] - 2023-04-21 ### Removed + - Remove Benedict (core dependency) as the default dict for JSON coming from CMR ([#229](https://github.com/nsidc/earthaccess/pull/229), [#230](https://github.com/nsidc/earthaccess/issues/230))([**@psarka**](https://github.com/psarka)) ### Fixed + - S3 credential endpoints are tried with tokens and basic auth until all the DAACs accept the same auth ([#234](https://github.com/nsidc/earthaccess/pull/234))([**@betolink**](https://github.com/betolink)) ## [0.5.1] - 2023-03-20 ### Changed + - For CI, documentation for readthedocs fixed by including poetry as the default tool ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) - For CI, injected new secrets to test Auth using the icepyx convention (EARTHDATA_USERNAME) ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@JessicaS11**](https://github.com/JessicaS11), [**@betolink**](https://github.com/betolink)) ### Added + - Add ability to get the user's profile with auth.user_profile which includes the user email ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) - Add LAAD as a supported DAAC ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) ### Removed + - Remove magic from dependencies (not available in windows and not used but just in tests) ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) ### Fixed + - `get_s3_credentials()` only worked when a netrc file was present, bug reported by @scottyhq and @JessicaS11 ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink), [**@JessicaS11**](https://github.com/JessicaS11), [**@scottyhq**](https://github.com/scottyhq)) - Include tests for all DAAC S3 endpoints ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) - Update notebooks to use the new top level API ([#214](https://github.com/nsidc/earthaccess/pull/214))([**@betolink**](https://github.com/betolink)) @@ -170,14 +197,17 @@ ## [0.5.0] - 2023-02-23 ### Changed + - For CI, documentation is now only built for the main, dev and documentation branches ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) - For CI, notebooks are executed every time the documentation gets published! ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink), [**@asteiker**](https://github.com/asteiker)) ### Added + - Add ability to use the top level API to get S3 credentials, authenticated fsspec and requests sessions! ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) - Make available ASF direct access for Sentinel1 products ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) ### Fixed + - Fix a bug where the Auth class is invoked without the proper parameters ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@JessicaS11**](https://github.com/JessicaS11)) - Raise and exception if a user specifies the netrc strategy and there is no netrc ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) - S3 URLs broke the Store class when opened outside AWS ([#202](https://github.com/nsidc/earthaccess/pull/202))([**@betolink**](https://github.com/betolink)) @@ -186,6 +216,7 @@ ## [0.4.7] - 2022-12-11 ### Fixed + - Fix open() for direct access ([#186](https://github.com/nsidc/earthaccess/pull/186))([**@betolink**](https://github.com/betolink)) - Move python-magic to the dev section because it is a test dependency ([#186](https://github.com/nsidc/earthaccess/pull/186))([**@betolink**](https://github.com/betolink)) - Make minor edits in the README ([#186](https://github.com/nsidc/earthaccess/pull/186))([**@betolink**](https://github.com/betolink)) @@ -193,27 +224,32 @@ ## [0.4.6] - 2022-12-08 ### Changed + - For CI, only run the publish workflow after a release on GitHub ([#183](https://github.com/nsidc/earthaccess/pull/183))([**@betolink**](https://github.com/betolink)) ### Added + - Add feature to search collections by DOI ([#183](https://github.com/nsidc/earthaccess/pull/183))([**@betolink**](https://github.com/betolink)) - Add new API documentation and simplify notation to access data ([#183](https://github.com/nsidc/earthaccess/pull/183)) ([**@jroebuck932**](https://github.com/jroebuck932)) ## [0.4.1] - 2022-11-02 ### Changed + - For CI, install Poetry using the new script ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) - For CI, change dependabot alerts to monthly ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) - Improve documentation by reimplementing python_cmr methods for docstring compatibility ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) - Use `CMR-Search-After` see #145 ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) ### Added + - Add GES_DISC S3 endpoint ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) - Improve documentation by adding types to method signatures ([#131](https://github.com/nsidc/earthaccess/pull/131)) ([**@betolink**](https://github.com/betolink)) ## [0.4.0] - 2022-08-17 ### Added + - Add store, auth to docs and update mkdocs config ([#119](https://github.com/nsidc/earthaccess/pull/119))([**@betolink**](https://github.com/betolink)) - For `auth`, add the ability to persist credentials into a `.netrc` file ([#119](https://github.com/nsidc/earthaccess/pull/119))([**@betolink**](https://github.com/betolink)) - For `store`, use fsspec s3fs for in cloud access and https sessions for out of region access ([#43](https://github.com/nsidc/earthaccess/issues/43))([**@betolink**](https://github.com/betolink)) @@ -222,30 +258,36 @@ ## [0.3.0] - 2022-04-28 ### Changed + - Update python-cmr to NASA fork ([#75](https://github.com/nsidc/earthaccess/pull/75))([**@jhkennedy**](https://github.com/jhkennedy)) - Drop unused `pydantic` dependency ([`5761548`](https://github.com/nsidc/earthaccess/pull/75/commits/5761548fcd8ba8733ce4f5ff9b8ce7967c3a8398))([**@jhkennedy**](https://github.com/jhkennedy)) - Auth can refresh CMR tokens ([#82](https://github.com/nsidc/earthaccess/pull/82))([**@betolink**](https://github.com/betolink)) - Verify git tag and poetry version are the same before publishing to PyPI ### Added + - Add documentation for readthedocs and GitHub ([#82](https://github.com/nsidc/earthaccess/pull/82))([**@betolink**](https://github.com/betolink)) ### Removed + - **Breaking**: Drop python 3.7 support ([#82](https://github.com/nsidc/earthaccess/pull/82))([**@betolink**](https://github.com/betolink)) ### Fixed + - Fix bug with CMR tokens - Add missing `python-datutil` dependency ([`747e992`](https://github.com/nsidc/earthaccess/pull/75/commits/747e9926a5ab83d75bbf7f17d4c52f24b563147b))([**@jhkennedy**](https://github.com/jhkennedy)) ## [0.2.2] - 2022-03-23 ### Fixed + - Fix store to download multi-file granules ([#73](https://github.com/nsidc/earthaccess/pull/73))([**@betolink**](https://github.com/betolink)) - Fix granule formatting ([#73](https://github.com/nsidc/earthaccess/pull/73))([**@betolink**](https://github.com/betolink)) ## [0.2.1] - 2022-03-19 ### Changed + - Rename Accessor to Store ([`4bd618d`](https://github.com/nsidc/earthaccess/pull/66/commits/4bd618d4d48c3cd256a077fb8329f40df2d5b7ff))([**@betolink**](https://github.com/betolink)) - Relax dependency requirements ([`c9a5ed6`](https://github.com/nsidc/earthaccess/pull/66/commits/c9a5ed6b917435e7c4ece58485939065fa71cc8f))([**@betolink**](https://github.com/betolink)) - Store can download plain links if they are on prem ([`92d2919`](https://github.com/nsidc/earthaccess/commit/92d291962e5b72b458c2971eae8a6b813d4bae39))([**@betolink**](https://github.com/betolink)) @@ -255,6 +297,7 @@ _Conception!_ ### Added + - Add basic classes to interact with NASA CMR, EDL and cloud access. - Basic object formatting. From 0ec48491f162fc0ae478ea620955f826cf24120b Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 8 Jul 2024 17:16:49 +0000 Subject: [PATCH 07/10] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/contributing/maintainers-guide.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/contributing/maintainers-guide.md b/docs/contributing/maintainers-guide.md index 1ac2fc79..2d54a354 100644 --- a/docs/contributing/maintainers-guide.md +++ b/docs/contributing/maintainers-guide.md @@ -53,6 +53,3 @@ The GitHub Actions CI services handle the project's building, testing, and manag ## Continuous Documentation [ReadTheDocs](https://readthedocs.org/projects/earthaccess/) is used to generate and host [our documentation website](https://earthaccess.readthedocs.io/) as well as the preview for documentation changes made in pull requests. This service uses a configuration file in the root of the project, `.readthedocs.yml`. - - - From fdc080cd0df0fe248a7cc8f088988afdf9a514b3 Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Tue, 9 Jul 2024 11:10:51 -0400 Subject: [PATCH 08/10] Add a few missing entries to the CHANGELOG.md --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1fc09a87..d035ef57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -115,6 +115,7 @@ - earthaccess will `raise` errors instead of `print`ing them in more cases ([#351](https://github.com/nsidc/earthaccess/pull/351))([**@jrbourbeau**](https://github.com/jrbourbeau)) - `daac` and `provider` parameters are now normalized to uppercase, since lowercase characters are never valid ([#355](https://github.com/nsidc/earthaccess/pull/355))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) +- Allow single file URL inputs for `earthaccess.download` ([#347](https://github.com/nsidc/earthaccess/pull/347))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mfisher87**](https://github.com/mfisher87)) ### Fixed @@ -161,10 +162,17 @@ ## [0.5.3] - 2023-08-01 +### Added + +- Add download from onprem how-to ([#265](https://github.com/nsidc/earthaccess/pull/265))([**@andypbarrett**](https://github.com/andypbarrett)) + ### Changed - For CI, integration tests are now only run when we push to main (after a merge) ([#267](https://github.com/nsidc/earthaccess/pull/267))([**@betolink**](https://github.com/betolink)) - For CI, unit tests are run for any branch and opened PR ([#267](https://github.com/nsidc/earthaccess/pull/267))([**@betolink**](https://github.com/betolink)) +- Update example in `search_datasets` ([#247](https://github.com/nsidc/earthaccess/pull/247))([**@jrbourbeau**](https://github.com/jrbourbeau)) +- Improve remote cluster performance ([#259](https://github.com/nsidc/earthaccess/pull/259))([**@jrbourbeau**](https://github.com/jrbourbeau), [**@mrocklin**](https://github.com/mrocklin), [**@mfisher87**](https://github.com/mfisher87)) +- Return useful error message for failed download ([#263](https://github.com/nsidc/earthaccess/pull/263))([**@andypbarrett**](https://github.com/andypbarrett)) ### Fixed From ee33da9fe2e7e1729c1baca26ba3aa024774f297 Mon Sep 17 00:00:00 2001 From: danielfromearth Date: Tue, 9 Jul 2024 11:20:55 -0400 Subject: [PATCH 09/10] change changelog to contain change entry about changing the changelog --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index fed43dcf..506d46b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,10 @@ ([#511](https://github.com/nsidc/earthaccess/issues/511)) ([**@botanical**](https://github.com/botanical),[**@chuckwondo**](https://github.com/chuckwondo), [**@mfisher87**](https://github.com/mfisher87)) +- Update `CHANGELOG.md` to follow Common Changelog conventions + ([#584](https://github.com/nsidc/earthaccess/pull/584)) + ([**@danielfromearth**](https://github.com/danielfromearth),[**@chuckwondo**](https://github.com/chuckwondo), + [**@jhkennedy**](https://github.com/jhkennedy),[**@mfisher87**](https://github.com/mfisher87)) ### Added From a1ee17d351c8beeddb2fe210bb1bf93917da1d25 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 9 Jul 2024 12:41:26 -0600 Subject: [PATCH 10/10] Add note about Common Changelog to PR template --- .github/pull_request_template.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 60c23104..95911c4f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -33,7 +33,8 @@ created the PR as a non-draft, don't worry, you can still change it to a draft u example `closes #1`. See [GitHub docs - Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). - [ ] Update `CHANGELOG.md` with details about your change in a section titled - `## Unreleased`. If such a section does not exist, please create one. + `## Unreleased`. If such a section does not exist, please create one. Follow + [Common Changelog](https://common-changelog.org/) for your additions. - [ ] Update the documentation and/or the `README.md` with details of changes to the earthaccess interface, if any. Consider new environment variables, function names, decorators, etc.