Skip to content

Add SDK compatibility details #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zvikagart merged 4 commits into from
Jan 28, 2025
Merged

Add SDK compatibility details #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
def0973
add compatibility table to README.md
jake-valsamis Jan 28, 2025
8845e8a
add min CO version to CHANGELOG.md
jake-valsamis Jan 28, 2025
9492b0b
Update README.md with compatibility guidelines
jake-valsamis Jan 28, 2025
b62c803
Update README.md
zvikagart Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).