diff --git a/CHANGELOG.md b/CHANGELOG.md index 2db5029..ef8dbd7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ CHANGELOG - [#21](https://github.com/codeocean/codeocean-sdk-python/pull/21) feat: Code Ocean Version 3.1 updates - [#18](https://github.com/codeocean/codeocean-sdk-python/pull/18) feat: Combined data asset - [#16](https://github.com/codeocean/codeocean-sdk-python/pull/16) fix: revert default number of retries to 0 +- **Minimum Code Ocean platform version updated to `3.1.0`.** ## 0.2.0 (2024-10-21) diff --git a/README.md b/README.md index 3067c80..6e2a003 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,8 @@ For development, install from source with: ```sh pip install -e .[dev] -U ``` +# Code Ocean Python SDK Version Compatibility + +Each release of this Code Ocean Python SDK is tested and verified against a specific minimum version of the Code Ocean platform API. Generally, this minimum version is the latest Code Ocean version at the time of the SDK’s release. +We recommend ensuring your SDK dependency is pinned to a version compatible with your Code Ocean deployment. +For details on when the minimum Code Ocean platform version changes, see the [CHANGELOG](CHANGELOG.md).