Sentinelsat

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

Added
~~~~~
* Query keywords with interval ranges now also support single-sided ranges by using ``None`` or ``'*'`` to denote no bound,
for example ``query(date=(None, 'NOW-1YEAR'))``. If both bounds are set to unlimited, the keyword will be removed
from the query. (`210 <https://github.com/sentinelsat/sentinelsat/issues/210>`_)
* Raise an exception in case of duplicate keywords present in a query. Case is ignored to match the server-side behavior. (`210 <https://github.com/sentinelsat/sentinelsat/issues/210>`_)
* Support for Python 3.7
* Support for GeoJSON files with a single ``Feature`` without a ``FeatureCollection.`` (`224 <https://github.com/sentinelsat/sentinelsat/issues/224>`_ `scottstanie <https://github.com/scottstanie>`_)
* Added support for Unicode symbols in search queries. (`230 <https://github.com/sentinelsat/sentinelsat/issues/230>`_)
* Raise ValueError exception if longitude is outside [-180, 180] or latitude is outside [-90, 90] (`236 <https://github.com/sentinelsat/sentinelsat/issues/236>`_, `#218 <https://github.com/sentinelsat/sentinelsat/issues/218>`_ `Andrey-Raspopov <https://github.com/Andrey-Raspopov>`_)
* optional ``timeout`` attribute to avoid indefinite wait on response from the server (`256 <https://github.com/sentinelsat/sentinelsat/issues/256>`_, `viktorbahr <https://github.com/viktorbahr>`_)
* Parsing the ``Online``, ``CreationDate`` and ``IngestionDate`` fields of an OData response
* Trying to download an offline product from the Copernicus Open Access Hub triggers its retrieval from the long term archive.
Downloading of the product is **not** scheduled.
* Added support for downloading Sentinel 5P data in the CLI via the '--sentinel 5' flag

Changed
~~~~~~~
* Add support in the CLI for reading credentials from `~/.netrc` and document existing functionality in the API (`90 <https://github.com/sentinelsat/sentinelsat/issues/90>`_)

Fixed
~~~~~
* Spaces in query parameter values are now handled correctly be escaping them with a backslash, where appropriate. (`169 <https://github.com/sentinelsat/sentinelsat/issues/169>`_, `#211 <https://github.com/sentinelsat/sentinelsat/issues/211>`_)
* Fixed some CLI errors not returning a non-zero exit code. (`209 <https://github.com/sentinelsat/sentinelsat/issues/209>`_)
* Fixed typo for ``area_relation`` query parameter documentation from ``'Intersection'`` to ``'Intersects'``. (`225 <https://github.com/sentinelsat/sentinelsat/issues/225>`_ `scottstanie <https://github.com/scottstanie>`_)
* Updated ``check_query_length()`` logic to match the changed server-side behavior. (`230 <https://github.com/sentinelsat/sentinelsat/issues/230>`_)
* Clarify usage of GeoJSON files with CLI in docs (`229 <https://github.com/sentinelsat/sentinelsat/issues/229>`_ `psal93 <https://github.com/psal93>`_)
* ``to_geopandas()`` now returns an empty GeoDataFrame for an empty product list input.

Development Changes
~~~~~~~~~~~~~~~~~~~
* Replaced ``[test]`` and ``[docs]`` with a single ``[dev]`` installation extras target. (`208 <https://github.com/sentinelsat/sentinelsat/issues/208>`_)
* Adapted `.travis.yml` to build `fiona` and `pyproj` from source for Python 3.7.
* Minimum pytest version ``pytest >= 3.6.3`` required by ``pytest-socket``.
* The existing practice of not accessing the network from unit tests, unless running with ``--vcr record_new`` or
``--vcr reset``, is now enforced by throwing a ``SocketBlockedError`` in such cases. (`207 <https://github.com/sentinelsat/sentinelsat/issues/207>`_)

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

Added
~~~~~
* made exceptions more verbose regarding optional dependencies (`176 <https://github.com/sentinelsat/sentinelsat/issues/176>`_)
* CLI username, password and DHuS URL can be set with environment variables ``DHUS_USER``, ``DHUS_PASSWORD`` and ``DHUS_URL`` (`184 <https://github.com/sentinelsat/sentinelsat/issues/184>`_, `temal- <https://github.com/temal->`_)
* added information about known errors and DHuS issues to docs (`186 <https://github.com/sentinelsat/sentinelsat/issues/186>`_, `martinber <https://github.com/martinber>`_)

Changed
~~~~~~~
* remove hard coded product type list from cli (`190 <https://github.com/sentinelsat/sentinelsat/issues/190>`_, `lenniezelk <https://github.com/lenniezelk>`_)
* Made the function signature of ``count()`` fully compatible with ``query()``. Irrelevant parameters are simply ignored.

Deprecated
~~~~~~~~~~
* environment variables ``SENTINEL_USER`` and ``SENTINEL_PASSWORD`` are superceded by ``DHUS_USER`` and ``DHUS_PASSWORD``

Fixed
~~~~~
* Updated handling of invalid queries. An exception is raised in such cases. `168 <https://github.com/sentinelsat/sentinelsat/issues/168>`_
* Fixed ``order_by`` parameter being ignored in queries that require multiple subqueries (that is, queries that return
more than 100 products) (`200 <https://github.com/sentinelsat/sentinelsat/issues/200>`_)
* Special handling of quote symbols in query strings due to a server-side error is no
longer necessary and has been removed. `168 <https://github.com/sentinelsat/sentinelsat/issues/168>`_
* Updated effective query length calculation in ``check_query_length()`` to reflect
server-side changes.
* skip failing tests on optional dependency Pandas for Python 3.3 and 3.4
* Unit tests work irrespective of the directory they are run from.

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

Changed
~~~~~~~
* Made checksumming the default behavior, and removed its flag from the CLI. (`gbaier2 <https://github.com/gbaier2>`_)

Fixed
~~~~~
* set ``requests`` encoding to UTF8
* fixed a backwards incompatible change in the ``geojson`` dependency
* inconsistent documentation on the use of range parameters such as ``date=``

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

Added
~~~~~
* Option to change the type of spatial relation for the AOI in ``query()``.
The choices are 'Interesects', 'Contains' and 'IsWithin'.
* ``order_by`` option to ``query()`` which controls the fields by which the products are sorted on the
server side before being returned. ``-o/--order-by`` on the CLI.
* ``limit`` the number of products returned by ``query()`` and to set the number
of products to skip via ``offset``. ``-l/--limit`` on the CLI.
* Added ``raw`` parameter to ``query()`` to append any additional raw query string to the query.
* Query parameters that take intervals as values can now be passed a tuple of the interval range values.
* Date validation and parsing has been extended to all date-type parameters in queries, such as 'ingestiondate'.
* Added ``count()`` which quickly returns the number of products matching a query on the server
without retrieving the full response.
* Method ``check_query_length`` to check if a query will fail because of being excessively long.
* Option to adjust the number of decimal figures in the coordinates of the WKT string returned by ``geojson_to_wkt()``.
* CLI option to query by UUID (``--uuid``) or filename (``--name``).
* A more informative error message is shown if a too long query string was likely the cause
of the query failing on the server side.
This can be useful if the WKT string length would cause the query to fail otherwise.
* Progressbars can be disabled by setting ``show_progressbars`` to ``False``.
Progressbars may be customized by overriding the ``_tqdm()`` method.
* Contribution guidelines.
* Tests for validity of documentation and RST files.

Changed
~~~~~~~
* Merged CLI subcommands ``sentinel search`` and ``sentinel download`` into ``sentinelsat``.
* CLI uses keywords instead of positional arguments, i.e. ``--user <username>``.
* ``initial_date`` and ``end_date`` parameters in ``query()`` have been replaced with a single
``date`` parameter that takes a tuple of start and end dates as input.
* Files being downloaded now include an '.incomplete' suffix in their name until the download is finished.
* Removed ``check_existing`` option from ``download()`` and ``download_all()``.
Similar functionality has been provided in the new ``check_files()`` function.
* ``format_query_date`` has been changed into a public function.
* Added a progressbar to long-running queries.
* Tests can now be run from any directory rather than the repository root.
* Made the query string slightly more compact by getting rid of unnecessary 'AND' operators, spaces and parentheses.
* Reduced the size of the VCR.py cassettes used in unit tests.
* changed license from AGPLv3 to GPLv3+

Deprecated
~~~~~~~~~~
* ``query_raw()`` has been merged with ``query()`` and is deprecated. Use ``query(raw=...)`` instead.

Fixed
~~~~~
* Show the correct progress value in the download progressbar when continuing from an incomplete file. (Thanks `gbaier <https://github.com/gbaier>`_!)
* Added a workaround for a server-side bug when plus symbols are used in a query.

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

Changed
~~~~~~~
* Replace ``pycurl`` dependency with ``requests``. This makes installation significantly easier. (`117 <https://github.com/sentinelsat/sentinelsat/issues/117>`_)
* An exception is raised in ``download_all()`` if all downloads failed.
* Change 'Sentinels Scientific Datahub' to 'Copernicus Open Access Hub' (`100 <https://github.com/sentinelsat/sentinelsat/issues/100>`_)
* Renamed ``py.test`` option ``--vcr reset_all`` to ``--vcr reset`` to better reflect its true behavior.

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

Added
~~~~~
* GeoJSON footprints are allowed to contain just a single geometry instead of a feature
collection. Any geometry type that has a WKT equivalent is supported (rather than only
Polygons).
* ``get_product_odata()`` can be used to get the full metadata information available for a
product if ``full=True`` is set.
* Added ``query_raw()`` that takes full text search string as input and returns a parsed
dictionary just like the updated ``query()`` method.
* CLI: ``--sentinel=<int>`` option to select satellite (constellation)

Changed
~~~~~~~
* ``SentinelAPI``, etc. can be directly imported from ``sentinelsat`` rather than
``sentinelsat.sentinel``.
* ``query()`` changes:

- The ``area`` argument expects a WKT string as input instead of a coordinate string.
(Issue `101 <https://github.com/sentinelsat/sentinelsat/issues/101>`_)
- Date arguments can be disabled by setting them to ``None`` and their values are
validated on the client side. (Issue `101 <https://github.com/sentinelsat/sentinelsat/issues/101>`_)
- The return value has been changed to a dict of dicts of parsed metadata values. One entry per
product with the product ID as the key.

* ``download_all()`` expects a list of product IDs as input. This is compatible with the output of
``query()``.
* ``get_coordinates()`` has been replaced with functions ``read_geojson()`` and
``geojson_to_wkt()``. (Issue `101 <https://github.com/sentinelsat/sentinelsat/issues/101>`_)
* Use more compact and descriptive error messages from the response headers, if available.

Deprecated
~~~~~~~~~~
* CLI: ``--sentinel1`` and ``--sentinel2`` will be removed with the next major release

Removed
~~~~~~~
* ``to_dict()`` has been removed since it is no longer required.
* ``load_query()`` has been made private (renamed to ``_load_query()``).


Fixed
~~~~~
* Fixed invalid GeoJSON output in both the CLI and API. (Issue `104 <https://github.com/sentinelsat/sentinelsat/issues/104>`_)
* Fixed broken reporting of failed downloads in the CLI. (Issue `88 <https://github.com/sentinelsat/sentinelsat/issues/88>`_)
* Attempting to download a product with an invalid ID no longer creates an infinite loop and a
more informative error message is displayed in the CLI.