Py3dep

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

Breaking Changes
~~~~~~~~~~~~~~~~
- Set the request caching's expiration time to never expire. Add two flags to all
functions to control the caching: ``expire_after`` and ``disable_caching``.

Internal Changes
~~~~~~~~~~~~~~~~
- Add all the missing types so ``mypy --strict`` passes.
- Improve performance of ``elevation_bygrid`` by ignoring unnecessary validation.

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

Internal Changes
~~~~~~~~~~~~~~~~
- Use ``rioxarray`` for dealing with ``GeoTIFF`` binaries since ``xarray``
deprecated the ``xarray.open_rasterio`` function, as it's discussed
in this `PR <https://github.com/pydata/xarray/pull/5808>`__.
- Use ``importlib-metadata`` for getting the version instead of ``pkg_resources``
to decrease import time as discussed in this
`issue <https://github.com/pydata/xarray/issues/5676>`__.

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

Breaking Changes
~~~~~~~~~~~~~~~~
- Rewrite the command-line interface using ``click.group`` to improve UX.
The command is now ``py3dep [command] [args] [options]``. The two supported commands are
``coords`` for getting elevations of a dataframe of coordinates in ``EPSG:4326`` CRS
and ``geometry`` for getting the elevation of a geo-dataframe of geometries. Each sub-command
now has a separate help message. The format of the input file for the ``coords`` command
is now ``csv`` and for the ``geometry`` command is ``.shp`` or ``.gpkg`` and must have a
``crs`` attribute. Also, the ``geometry`` command now accepts multiple layers via the
``--layers`` (``-l``) option. More information and examples can be in the ``README.rst`` file.

New Features
~~~~~~~~~~~~
- Make ``fill_depressions`` function public. This function conditions an input DEM
by applying
`depression filling <https://richdem.readthedocs.io/en/latest/depression_filling.html>`__
and
`flat area resolution <https://richdem.readthedocs.io/en/latest/flat_resolution.html>`__
operations.

Internal Changes
~~~~~~~~~~~~~~~~
- The ``get_map`` function now checks for validation of the input ``layers`` argument before
sending the actual request with a more helpful message.
- Improve docstrings.
- Move ``deg2mpm``, ``fill_depressions``, and ``reproject_gtiff`` functions to a new file
called ``utils``. Both ``deg2mpm`` and ``fill_depressions`` functions are still accessible
from ``py3dep`` directly.
- Increase the test coverage.
- Use one of the ``click``'s internal functions, ``click..testing.CliRunner``,
to run the CLI tests.

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

Bug Fixes
~~~~~~~~~
- Fix a bug related to ``elevation_bycoords`` where CRS validation fails if its
type is ``pyrpoj.CRS`` by converting inputs with CRS types to string.

Internal Changes
~~~~~~~~~~~~~~~~
- Fix a couple of typing issues and update the ``get_transform`` API based on the
recent changes in ``pygeoutils`` v0.11.5.

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

The first highlight of this release is a major refactor of ``elevation_bycoords`` by
adding support for the Bulk Point Query Service and improving the overall performance
of the function. Another highlight is support for performing depression filling
in ``elevation_bygrid`` before sampling the underlying DEM.

New Features
~~~~~~~~~~~~
- Refactor ``elevation_bycoords`` function to add support for getting
elevations of a list of coordinates via The National Map's
`Point Query Service <https://apps.nationalmap.gov/bulkpqs/>`__. This service is more
accurate than Airmap, but it's limited to the US only. You can select the source via
a new argument called ``source``. You can set it to ``source=tnm`` to use the TNM
service. The default is ``tnm``.
- Refactor ``elevation_bygrid`` function to add a new capability via ``fill_depressions``
argument for filling depressions in the obtained DEM before extracting elevation data
for the input grid points. This is achieved via
`RichDEM <https://richdem.readthedocs.io>`__ that needs to be installed if this
functionality is desired. You can install it via ``pip`` or ``conda`` (``mamba``).

Internal Changes
~~~~~~~~~~~~~~~~
- Migrate to using ``AsyncRetriever`` for handling communications with web services.
- Handle the interpolation step in ``elevation_bygrid`` function more efficiently
using ``xarray``.

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

New Features
~~~~~~~~~~~~
- Added command-line interface (:issue_3dep:`10`).
- All feature query functions use persistent caching that can significantly improve
the performance.

Breaking Changes
~~~~~~~~~~~~~~~~
- Drop support for Python 3.6 since many of the dependencies such as ``xarray`` and ``pandas``
have done so.
- The returned ``xarray`` objects are in parallel mode, i.e., in some cases ``compute`` method
should be used to get the results.
- Save the output as a ``netcdf`` instead of ``raster`` since conversion
from ``nc`` to ``tiff`` can be easily done with ``rioxarray``.