Skip to content

Ocean Data Platform (ODP) SDK Documentation

Overview

The Ocean Data Platform (ODP) Software Development Kit (SDK) is an open source Python library designed to streamline interaction with the ODP API and seamlessly integrate ODP functionalities into your applications. This documentation serves as a comprehensive guide for developers looking to utilize the ODP SDK.

Key Features

  • Authentication: Easily authenticate with the ODP to access secured resources.
  • Data Catalog: Access and utilize the ODP Data Catalog for interacting with datasets.
  • Raw Storage: Perform operations on raw storage, including file uploads, downloads, and deletions.
  • Tabular Storage: Get and store tabular data in your datasets.

Getting Started

Follow the steps below to quickly get started with the Ocean Data Platform (ODP) SDK:

  1. Installation: Install the ODP SDK in your project using pip.

  2. Authentication: Configure authentication with the ODP.

  3. Data Catalog: Integrate with the ODP Data Catalog to discover available datasets.

  4. Tabular Storage: Perform operations on tabular storage, including data retrieval and storage.

  5. Raw Storage: Perform operations on raw storage for file uploads, downloads, and deletions.

  6. Examples: Explore examples of how to use the ODP SDK to interact with the ODP API.

TLDR

Install
pip install odp-sdk
List all catalog items
from odp.client import OdpClient

client = OdpClient()

catalog_client = client.catalog

for item in catalog_client.list():
    print(item)