oncdw

Submodules

Classes

ONCDW

A wrapper class for Oceans 3.0 data widgets.

Package Contents

class oncdw.ONCDW

A wrapper class for Oceans 3.0 data widgets.

All the client library’s functionality is provided as methods of this class’s members, namely widget, ui, and section.

Parameters:

  • token (str) – The ONC API token, which could be retrieved at https://data.oceannetworks.ca/Profile once logged in. It can be set as a parameter or by using an environment variable called ONC_TOKEN.

  • env (str, default "PROD") – Whether the ONC Production server URL is used for service requests. Can be “PROD” or “QA”.

  • show_info (boolean, default False) – Whether verbose script messages are displayed, such as request url.

Examples

>>> from oncdw import ONCDW
>>> client = ONCDW()  # Works if the token is set by an env variable ONC_TOKEN
>>> client2 = ONCDW("YOUR_TOKEN_HERE")
>>> client3 = ONCDW("YOUR_TOKEN_HERE", show_info=True, env="QA")
token: str | None = None
env: str = 'PROD'
show_info: bool = False
property hostname: str