Changelog

Version 0.7.0

  • Make the caching logic opt-in and deactivated by default (#61).

  • Update the CI setup to support Python 3.10 and 3.11 (#60)

  • Add support for proxies when using pywaterinfo behind a company http proxy (#59, by @stijnvanlooy)

Version 0.6.0

  • Add support for datetime with zoneinfo tzinfo in python 3.9 (#48, by dbkhout)

  • Add citation file using Citation File Format (CFF) (#43)

Version 0.5.1

  • Fix wrong package metadata on supported Python versions.

Version 0.5.0

  • The package now also supports requests without ‘optional fields’ (#42).

  • Deprecate python 3.6 dus to incompatibility with requests-cache.

  • Fix cache retention handling in new requests-cache version.

  • Update the pyscaffold blueprint of the package with updated development workflow (#36).

  • Fix deprecation warning on loading pkgresources with relative path (#39 ).

  • Improve docstrings (#38).

Version 0.4.0

  • Switch local caching (#32) to temporary os directoy instead of project directory

  • Extend example/documentation:

    • Add example on how to request start/end date of a time series metadata (#33)

Version 0.3.1

  • Extend example/documentation:

    • Add caching page to index of manual pages

Version 0.3.0

  • Add local caching of API requests using the requests-cache package.

  • Adjust root URL for HIC based API calls according to online documentation https://hicws.vlaanderen.be/.

  • User can use custom time zone instead of UTC as default.

  • Extend examples/documentation for specific:

    • Limit the returned fields of get_timeseries_value_layer with metadata=False.

    • Add example on how to request tide numbers for high/low tide data.

Version 0.2.2

Fix token handling for HIC data requests.

Version 0.2.1

Hot fix on token handling (Thanks to Erik Bollen for reporting).

Version 0.2.0

Add support for SSL certificate handling.

Version 0.1.1

This version provides a first implementation wrapping the API provided by waterinfo.be. The package provides a minimal wrapper with the aim to find and download time series data and returns it as Pandas DataFrame. The latter enables methods for plotting and analysis.

  • Add Waterinfo class with base HTTP call method request_kiwis

  • Handle tokens automatically

  • Provide Python API equivalent for getTimeseriesValues, getTimeseriesValueLayer, getGroupList and getTimeseriesList

  • Create documentation website with SPhinx, unit tests using pytest, doctests

  • Setup of the CI using Github actions