Sentinelhub Py Versions Save

• Added max_retries parameter to SHConfig class. It controls how many times the client will attempt to re-download before raising OutOfRequestsException. It is set to None by default, in which case it never stops trying. Contributed by @Regan-Koopmans.

• Improved documentation for Copernicus Data Space Ecosystem.
• Restrict numpy version to <2 in anticipation of numpy 2.0 release.

This update ensures that session-sharing works as intended.

Changelog:

• Adjust session caching to mirror changes to the core services. Older version might no longer correctly cache sessions.
• Switch default auth endpoint to the new address.

• The SentinelHubDownloadClient class now has a default_retry_time parameter, which allows control over the waiting time when a request gets a 429 TOO_MANY_REQUESTS response without a specific retry time in the headers. The default value for this behavior has been changed from 0s to 30s to avoid edge-cases where SH services were bombarded with requests.

• Fixed a problem with dataclasses_json 0.6.2 that broke BYOC functionalities
• Removed AWS examples from the docs since the functionality is no longer maintained.

Changelog:

• SHConfig now correctly initializes a default profile in the file even if the first initialization call is done with a custom profile.
• Save and load methods of SHConfig adjusted to work with the environmental variable SH_PROFILE
• CLI command sentinelhub.config --show works with the environmental variable SH_PROFILE

Changelog:

• Adjusted how user credentials are passed to the OAuth service.
• Added QUALITY_FLAGS band to S3_OLCI
• Batch statistical API now supports IAM role style credentials.
• Various minor improvements

Changelog:

• The parameter sh_auth_base_url has been replaced with sh_token_url to allow authentication on endpoints with suffixes other than oauth/token. For the new parameter the address must be provided in full, e.g. https://services.sentinel-hub.com/oauth/token instead of https://services.sentinel-hub.com.The change only affects users who manually adjusted this field.
• The package has been adjusted to fully support Python 3.11. In the process base class of DataCollection was switched from enum.Enum to aenum.Enum, but we expect no behavioral changes.
• Various minor adjustments

This release focuses mostly on the changes regarding the Sentinel Hub configuration file (SHConfig) moving into the direction of a more common config usage:

• The format of the config file has been changed from JSON to TOML, which offers a more intuitive overview
• The config parameters can now be provided as input in the class constructor
• The location of the config file has been changed to ~/.config/sentinelhub/config.toml on Linux/MacOS and C:/Users/<USERNAME>/.config/sentinelhub/config.toml on Windows, which means that the configs are now separated from the repo location
  • all environments where sentinelhub-py is installed now use the configuration from the same source
  • installing new versions now doesn't reset the configuration
• The option of having multiple configuration files was removed
• Profiles were introduced, allowing users to define and use multiple profiles defined in the same location
  • only the updated fields are present in the configuration, the rest are equal to the default configuration parameters
• A limited support of environment variables was introduced.
  • SH_PROFILE that dictates which profile should be used when not explicitly provided.
  • SH_CLIENT_ID and SH_CLIENT_SECRET for setting the SentinelHub credentials.
• The general precedence order of the provided parameters is explicit parameters > environment > configuration file > defaults.

For more information about the configuration updates, check the Configuration section in the readthedocs.

Other changes in this release include:

• Removed support for Python 3.7. This should help with an easier Conda installation
• The package is now released as a wheel
• Added support for Async Process API
• Switched to a pyproject.toml based install, enabling a lighter package with fewer install files
• Increased tests performance and cleaned up deprecated functions

Changelog:

• Fixed a rate-limit bug that was introduced in version 3.8.2