diff --git a/README.md b/README.md index 65583bbc8ee3d1c8b4c0d9d4c491b758aef4bb1c..f1a77a95d8cc324b8e647a0ba9db9b07dd1d7980 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ </a> Largely inspired from *Microsoft Planetary Computer SDK*, **Dinamis-SDK** is -built on the STAC ecosystem and provides easy access to open-date Spot-6/7 +built on the STAC ecosystem and provides easy access to open-data Spot-6/7 imagery in COG format. ```python diff --git a/doc/credentials.md b/doc/credentials.md index 4372458d13bf9e7c1b6e1a6cc67f69d631c3cb9d..9ff33d6e57c9566ca67266b4adbad7b176d29f26 100644 --- a/doc/credentials.md +++ b/doc/credentials.md @@ -1,8 +1,11 @@ # Credentials -## Login +The credentials are retrieved using the device code flow on the first call of +`dinamis_sdk.sign_inplace()`. Just follow the instructions! -The credentials are then valid for 5 days. Every time +## Renewal + +The credentials are valid for 5 days. Every time `dinamis_sdk.sign_inplace` is called, the credentials are renewed for another 5 days. After 5 days idle, you will have to log in again. @@ -13,6 +16,13 @@ The signed URLs for STAC objects assets are valid during 7 days starting after !!! Info - `dinamis_sdk.sign_inplace` can also be applied directly on a particular + `dinamis_sdk.sign_inplace()` can also be applied directly on a particular `pystac.item`, `pystac.collection`, `pystac.asset` or any URL as `str`, with the same outcome in term of expiry. + +!!! Warning + + Do no confuse credentials validity with images URL token validity. + Both have different lifecycle. To read how to ask for longer + URLs time-to-live, please read the API reference of + `dinamis_sdk.sign_inplace()`.