Changelog

v2.5.1 (2025-07-12)

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).

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

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)

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.