diff --git a/README.md b/README.md index ba81b9e..638cda3 100644 --- a/README.md +++ b/README.md @@ -105,33 +105,6 @@ You'll need a personal access token. You can also provide your token directly to `EarthdataClient.login()`. -## Design goals - -As determined during a meeting at the Element 84 offices (formerly Azavea offices) on 2023-05-24. - -- [x] `async`-first -- [ ] Allow range requests -- [x] Download functionality -- [x] Update STAC items to point to new hrefs on download -- [x] Allow byte-stream access -- [ ] Protocols: - - [x] http - - [x] s3 - - [x] requestor pays - - [ ] custom endpoint - - [x] custom authentication - - [x] Planetary Computer - - [x] USGS EROS - - [x] NASA -- [ ] Copy directly from source to destination ("skip local") -- [ ] Add new assets to an item -- [ ] Update an existing asset -- [ ] Delete assets -- [ ] Templated paths on download -- [ ] (possible) Support the file extension's local path -- [ ] Checksum validation and creation -- [x] CLI - ## Versioning This project does its best to adhere to [semantic versioning](https://semver.org/). diff --git a/docs/design-goals.rst b/docs/design-goals.rst new file mode 100644 index 0000000..b466d4a --- /dev/null +++ b/docs/design-goals.rst @@ -0,0 +1,27 @@ +Design goals +============ + +As determined during a meeting at the Element 84 offices (formerly Azavea offices) on 2023-05-24. + +* [x] `async`-first +* [ ] Allow range requests +* [x] Download functionality +* [x] Update STAC items to point to new hrefs on download +* [x] Allow byte-stream access +* [ ] Protocols: + * [x] http + * [x] s3 + * [x] requestor pays + * [ ] custom endpoint + * [x] custom authentication + * [x] Planetary Computer + * [x] USGS EROS + * [x] NASA +* [ ] Copy directly from source to destination ("skip local") +* [ ] Add new assets to an item +* [ ] Update an existing asset +* [ ] Delete assets +* [ ] Templated paths on download +* [ ] (possible) Support the file extension's local path +* [ ] Checksum validation and creation +* [x] CLI diff --git a/docs/index.rst b/docs/index.rst index 35d9a6f..7dc7e7e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -80,4 +80,5 @@ For example, you could provide your own session to :py:meth:`~stac_asset.HttpCli :maxdepth: 2 :caption: Contents: + design-goals api \ No newline at end of file