From def09736a6cf0f372248fb4b1348cd09093b4867 Mon Sep 17 00:00:00 2001 From: jake-valsamis <107424756+jake-valsamis@users.noreply.github.com> Date: Mon, 27 Jan 2025 21:32:27 -0500 Subject: [PATCH 1/4] add compatibility table to README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 3067c80..70a395c 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,12 @@ For development, install from source with: ```sh pip install -e .[dev] -U ``` +# Code Ocean Python SDK Compatibility Table + +This table shows the compatibility between different versions of the Code Ocean Python SDK and the Code Ocean platform. + +| SDK Version | Compatible Code Ocean Platform Versions | Notes | +|--------------|---------------------------------------------|-------------------------------| +| 0.1.0 | 2.18 | Initial release of the SDK | +| 0.1.2 - 0.2.0| 2.18 - 3.0 | Minor bug fixes and updates | +| 0.3.0 | 3.1+ | Code Ocean v3.1 updates; breaking changes| From 8845e8a6e65407240a05252c829e011d565952f9 Mon Sep 17 00:00:00 2001 From: jake-valsamis <107424756+jake-valsamis@users.noreply.github.com> Date: Mon, 27 Jan 2025 21:37:08 -0500 Subject: [PATCH 2/4] add min CO version to CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) 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) From 9492b0b969f410213c7420eb3572f4535578ace5 Mon Sep 17 00:00:00 2001 From: jake-valsamis <107424756+jake-valsamis@users.noreply.github.com> Date: Tue, 28 Jan 2025 15:44:00 -0500 Subject: [PATCH 3/4] Update README.md with compatibility guidelines Co-authored-by: Zvika Gart --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 70a395c..b835d1a 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,8 @@ For development, install from source with: ```sh pip install -e .[dev] -U ``` -# Code Ocean Python SDK Compatibility Table +# Code Ocean Python SDK Version Compatibility -This table shows the compatibility between different versions of the Code Ocean Python SDK and the Code Ocean platform. - -| SDK Version | Compatible Code Ocean Platform Versions | Notes | -|--------------|---------------------------------------------|-------------------------------| -| 0.1.0 | 2.18 | Initial release of the SDK | -| 0.1.2 - 0.2.0| 2.18 - 3.0 | Minor bug fixes and updates | -| 0.3.0 | 3.1+ | Code Ocean v3.1 updates; breaking changes| +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 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). From b62c803dd27516cbc86541fa94be1b986e39a52e Mon Sep 17 00:00:00 2001 From: Zvika Gart Date: Tue, 28 Jan 2025 21:04:55 +0000 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b835d1a..6e2a003 100644 --- a/README.md +++ b/README.md @@ -21,5 +21,5 @@ 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 is pinned to a version compatible with your Code Ocean deployment. +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).