Skip to content

Commit

Permalink
docs: move design goals to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gadomski committed Jul 12, 2023
1 parent e007ef0 commit 5e81dd8
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 27 deletions.
27 changes: 0 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
27 changes: 27 additions & 0 deletions docs/design-goals.rst
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 5e81dd8

Please sign in to comment.