Skip to content

codeocean/codeocean-sdk-python

Repository files navigation

Code Ocean Logo

Code Ocean Python SDK

The Code Ocean Python SDK provides convenient access to the Code Ocean API from applications written in the Python language. This SDK enables you to manage Code Ocean resources such as Capsules, Data Assets, and Computations in your Python applications.

Documentation

The Code Ocean REST API documentation can be found in the Code Ocean User Guide.

Installation

pip install -U codeocean

For development, install from source with:

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.