odp-sdk

ODP Javascript SDK

This library is under active development, and the API is unstable until we publish v1.0.0 The ODP js library provides convenient access to Ocean Data Platform from applications written in client- or server-side JavaScript.

The SDK supports authentication through api-keys (for server-side applications) and bearer tokens (for web applications).

Installation

Install the package with yarn or npm:

# Install with yarn:
yarn add odp-sdk

# Install with NPM:
npm install odp-sdk --save

Usage

const { ODPClient } = require("odp-sdk")

Using ES modules

import { ODPClient } from "odp-sdk"

Using typescript

The SDK is written in native typescript, so no extra types needs to be defined.

Quickstart

Web

Backend

Documentation

• SDK documentation

Development

Run all tests:

$ yarn
$ yarn test

We use jest to run tests, see their documentation for more information.

Versioning

The library follow Semantic Versioning.

Contributing

Contributions welcome! See more details and the code of conduct.

Release

We follow the git flow methodology and a release branch will automatically trigger a new version

CHANGELOG

You can find it here.