Pygeoogc

-------------------

Breaking Changes
~~~~~~~~~~~~~~~~
- Append "Error" to all exception classes for conforming to PEP-8 naming conventions.

Internal Changes
~~~~~~~~~~~~~~~~
- Bump minimum version of ``owslib`` to 0.27.2 since the ``pyproj`` incompatibility issue
has been addressed in this issue.
- Bump minimum version of ``requests-cache`` to 0.9.6 since the ``attrs`` version issue
has been addressed.

-------------------

New Features
~~~~~~~~~~~~
- Add support for disabling persistent caching in ``RetrySession``
via an argument and also ``HYRIVER_CACHE_DISABLE`` environmental variable.

-------------------

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.
- Pin ``owslib`` to version <0.26 since version 0.26 has pinned ``pyproj`` to
version <3.3 which is not compatible with ``rasterio`` on macOS.

Internal Changes
~~~~~~~~~~~~~~~~
- Use `micromamba <https://github.com/marketplace/actions/provision-with-micromamba>`__
for running tests
and use `nox <https://github.com/marketplace/actions/setup-nox>`__
for linting in CI.

-------------------

New Features
~~~~~~~~~~~~
- More robust handling of errors in ``ArcGISRESTful`` by catching ``None``
responses. Also, use the ``POST`` method for ``ArcGISRESTful.bysql`` since
the SQL Clause could be a long string.

-------------------

Breaking Changes
~~~~~~~~~~~~~~~~
- Remove caching-related arguments from all functions since now they
can be set globally via 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:

.. code-block:: python

import os

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

Bug Fixes
~~~~~~~~~
- In ``ArcGISRESTful.oids_byfield`` convert the input ``ids`` to a
``list`` if a user passes a single ``id``.

Internal Changes
~~~~~~~~~~~~~~~~
- Refactor ``ServicURL`` to hard code the supported links instead of reading
them from a file. Also, the class now is based on ``NamedTuple`` that has a
nicer ``__repr__``.

-------------------

New Features
~~~~~~~~~~~~
- Make ``validate_crs`` public that can be accessed from the ``utils`` module.
This is useful for checking validity of user input CRS values and getting
its string representation.
- Add ``pygeoogc.utils.valid_wms_crs`` function for getting a list of valid
CRS values from a WMS service.
- Add 3DEP's index WFS service for querying availability of 3DEP data within a
bounding box.

Internal Changes
~~~~~~~~~~~~~~~~
- Add type checking with ``typeguard`` and fixed typing issues raised by
``typeguard``.
- Refactor ``show_versions`` to ensure getting correct versions of all
dependencies.