Skip to content

CHANGELOG.md

Latest commit

 

History

History
168 lines (110 loc) · 6.44 KB

CHANGELOG.md

File metadata and controls

168 lines (110 loc) · 6.44 KB

Changelog

v2.6.0 (2025-12-04)

Enhancements

  • Bump the minimum Python version from 3.9 to 3.10.

    This is in alignment with the status of Python versions.

  • ONC class can get the token by checking an environment variable called ONC_TOKEN. (#67).

    This means users can use onc = ONC() if ONC_TOKEN is set correctly (probably in a .env file)

  • Added a new method called getDataAvailability, which matches the new OpenAPI end point /dataAvailability/dataproducts. (#70).

  • Change the default value of showWarning to be True.

Fixes

  • Fix 0 file size in the print message when calling orderDataProduct (#64).

Contributors

v2.5.1 (2025-07-12)

Enhancements

  • Change the default value of showWarning to be False.

Fixes

  • Ignore timezone when parsing non-standard datetime like "YYYY-MM-DD". (#60)

Contributors

v2.5.0 (2025-02-13)

Enhancements

  • Added getArchivefileUrl and getArchivefileUrls to only return the download links of the requested archive files. (#56)

    This is useful because users can use them in their favorite download manager. Check the Code Example for more information.

  • Added warning messages if the response has a "messages" key with a non-empty list value. (#58)

    This feature can be turned off by using onc = ONC(token=TOKEN, showWarning=False).

Fixes

  • Reverted back the incremental downloading files because it might generate invalid files with partial file size (before it was zero file size). (#54)

Contributors

Reviewers panel

v2.4.1 (2024-09-24)

Fixes

  • Fixed duplicate downloading issues when the downloaded file exists and the overwrite parameter is False in downloadArchivefile, downloadDataProduct, and orderDataProduct. (#41)

  • Fixed incorrect time estimation when downloading scalardata in multiple pages. (#45)

Contributors

Reviewers panel

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