v0.3.8

Release Notes

New Features

• Add support for specifying the chunk size in stream_write. Defaults to None which was the default behavior before, and means iterating over and writing the responses as they are received from the server.

Internal Changes

• Use pyupgrade package to update the type hinting annotations to Python 3.10 style.
• Modify the codebase based on Refurb suggestions.

v0.3.7

Release Notes

New Features

• Add support for specifying the chunk size in stream_write. Defaults to None which was the default behavior before, and means iterating over and writing the responses as they are received from the server.

Internal Changes

• Use pyupgrade package to update the type hinting annotations to Python 3.10 style.
• Modify the codebase based on Refurb suggestions.

v0.3.6

Release Notes

Internal Changes

• Add the missing PyPi classifiers for the supported Python versions.
• Release the package as both async_retriever and async-retriever on PyPi and Conda-forge.

v0.3.5

Release Notes

Breaking Changes

• Append "Error" to all exception classes for conforming to PEP-8 naming conventions.

Internal Changes

• Bump minimum version of aiohttp-client-cache to 0.7.3 since the attrs version issue has been addressed.

v0.3.4

Release Notes

New Features

• Add a new function, stream_write, for writing a response to a file as it's being retrieved. This could be very useful for downloading large files. This function does not use persistent caching.

v0.3.3

Release Notes

Breaking Changes

• Set the minimum supported version of Python to 3.8 since many of the dependencies such as xarray, pandas, rioxarray have dropped support for Python 3.7.

Internal Changes

• Use micromamba for running tests and use nox for linting in CI.

v0.3.2

Release Notes

New Features

• Add support for setting caching-related arguments using three environmental variables:

  • HYRIVER_CACHE_NAME: Path to the caching SQLite database.
  • HYRIVER_CACHE_EXPIRE: Expiration time for cached requests in seconds.
  • HYRIVER_CACHE_DISABLE: Disable reading/writing from/to the cache file.

  You can do this like so:

import os

os.environ["HYRIVER_CACHE_NAME"] = "path/to/file.sqlite"
os.environ["HYRIVER_CACHE_EXPIRE"] = "3600"
os.environ["HYRIVER_CACHE_DISABLE"] = "true"

Internal Changes

• Include the URL of a failed request in its exception error message.

v0.3.1

Release Notes

New Features

• Add three new functions called retrieve_text, retrieve_json, and retrieve_binary. These functions are derived from the retrieve function and are used to retrieve the text, JSON, or binary content of a response. They are meant to help with type hinting since they have only one return type instead of three different return types that the retrieve function has.

Internal Changes

• Move all private functions to a new module called utils. This makes the code-base more readable and easier to maintain.

v0.3.0

Release Notes

Breaking Changes

• Set the expiration time to never expire by default.

New Features

• Add two new arguments to retrieve for controlling caching. First, delete_url_cache for deleting caches for specific requests. Second, expire_after for setting a custom expiration time.
• Expose the ssl argument for disabling the SSL certification
  verification (:issue_day:[41]{.title-ref}).
• Add a new option called disable that if True, it temporarily
  disables caching requests and gets new responses. It defaults to False.

v0.2.5

Release Notes

New Features

• Add two new arguments, timeout and expire_after, to retrieve. These two arguments gives the user more control for dealing with issues related to caching.

Internal Changes

• Revert to pytest as the testing framework.
• Use importlib-metadata for getting the version insead of
  pkg_resources to decrease import time as discussed in this issue.