Changelog

v2.4.0 (2024-05-30)

Enhancements

  • Improved package setup (pyproject.toml, linting and formatter). (#1)

    Now you can import the ONC class using from onc import ONC instead of from onc.onc import ONC. The longer version still works.

  • Added support of Path type for outPath (instance variable in ONC class). (#12)

  • Added GitHub Actions for continuous integration. (#19)

  • Added Sphinx for generating documentation. (#7)

  • Improved exception types raised and caught. (#17)

  • Added new public methods (checkDataProduct, cancelDataProduct, restartDataProduct, getSensorCategoryCodes) to match backend API update. (#26)

  • Renamed some public methods (old names are still available) to make the naming more consistent with the api end points. (#33)

    API End Point

    Old Name

    New Name

    /locations/tree

    getLocationHierarchy

    getLocationsTree

    /scalardata/location

    getDirectByLocation

    getScalardataByLocation

    /scalardata/device

    getDirectByDevice

    getScalardataByDevice

    /rawdata/location

    getDirectRawByLocation

    getRawdataByLocation

    /rawdata/device

    getDirectRawByDevice

    getRawdataByDevice

    /archivefile/location

    getListByLocation

    getArchivefileByLocation

    /archivefile/device

    getListByDevice

    getArchivefileByDevice

    /archivefile/download

    getFile

    downloadArchivefile

    N/A

    getDirectFiles

    downloadDirectArchivefile

  • Added helper methods to combine getXXXByLocation and getXXXByDevice into getXXX. (#33)

    Namely, getScalardata, getRawdata and getArchivefile.

Fixes

  • Removed unused modules (onc/ags.py, onc/dap.py, onc/nerc.py, onc/sos.py). (#1)

Tests

  • Added support using .env file for storing the token when running tests. (#2)

  • Replaced robot framework with pytest. (#10)

Contributors

Reviewers panel

v2.3.5 (2019-12-12) and before

Contributors