Globus-sdk

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

Added
~~~~~

* Add ``BaseClient`` to the top-level exports of ``globus_sdk``, so it can now
be accessed under the name ``globus_sdk.BaseClient``

Fixed
~~~~~

* Fix several paginators which were broken in ``3.0.0a3`` (:pr:`431`)

Documentation
~~~~~~~~~~~~~

* Autodocumentation of paginated methods (:pr:`432`)

.. _changelog-3.0.0a3:

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

Changed
~~~~~~~

* Pagination has changed significantly. (:pr:`418`)

* Methods which support pagination like ``TransferClient.endpoint_search`` no
longer return an iterable ``PaginatedResource`` type. Instead, these client
methods return ``GlobusHTTPResponse`` objects with a single page of results.

* Paginated variants of these methods are available by renaming a call from
``client.<method>`` to ``client.paginated.<method>``. So, for example, a
``TransferClient`` now supports ``client.paginated.endpoint_search()``.
The arguments to this function are the same as the original method.

* ``client.paginated.<method>`` calls return ``Paginator`` objects, which
support two types of iteration: by ``pages()`` and by ``items()``. To
replicate the same behavior as SDK v1.x and v2.x ``PaginatedResource``
types, use ``items()``, as in
``client.paginated.endpoint_search("query").items()``

.. _changelog-3.0.0a2:

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

Added
~~~~~

* A new subpackage is available for public use,
``globus_sdk.tokenstorage`` (:pr:`405`)

* Add client for Globus Groups API, ``globus_sdk.GroupsClient``. Includes a
dedicated error class, ``globus_sdk.GroupsAPIError``

Changed
~~~~~~~

* Refactor response classes (:pr:`425`)

.. _changelog-3.0.0a1:

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

Removed
~~~~~~~

* Remove ``allowed_authorizer_types`` restriction from ``BaseClient`` (:pr:`407`)

* Remove ``auth_client=...`` parameter to
``OAuthTokenResponse.decode_id_token`` (:pr:`400`)

Added
~~~~~

* ``globus-sdk`` now provides PEP561 typing data (:pr:`420`)

* ``OAuthTokenResponse.decode_id_token`` can now be provided a JWK and openid
configuration as parameters. ``AuthClient`` implements methods for fetching
these data, so that they can be fetched and stored outside of this call.
There is no automatic caching of these data. (:pr:`403`)

Changed
~~~~~~~

* The interface for ``GlobusAuthorizer`` now defines
``get_authorization_header`` instead of ``set_authorization_header``, and
additional keyword arguments are not allowed (:pr:`422`)

* New Transport layer handles HTTP details, variable payload
encodings, and automatic request retries (:pr:`417`)

* Instead of ``json_body=...`` and ``text_body=...``, use ``data=...``
combined with ``encoding="json"``, ``encoding="form"``, or
``encoding="text"`` to format payload data. ``encoding="json"`` is the
default when ``data`` is a dict.

* By default, requests are retried automatically on potentially transient
error codes (e.g. ``http_status=500``) and network errors with exponential
backoff

* ``globus_sdk.BaseClient`` and its subclasses define ``retry_policy``
and ``transport_class`` class attributes which can be used to customize the
retry behavior used

* The JWT dependency has been updated to ``pyjwt>=2,<3`` (:pr:`416`)

* The config files in ``~/.globus.cfg`` and ``/etc/globus.cfg`` are no longer
used. Configuration can now be done via environment variables (:pr:`409`)

* ``BaseClient.app_name`` is a property with a custom setter, replacing
``set_app_name`` (:pr:`415`)

Documentation
~~~~~~~~~~~~~

* Update documentation site style and layout (:pr:`423`)

.. _changelog_version2:

.. _changelog-2.0.1:

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

Python Support
~~~~~~~~~~~~~~

* Remove support for python2 (:pr:`396`, :pr:`397`, :pr:`398`)

.. note:: globus-sdk version 2.0.0 was yanked due to a release issue.
Version 2.0.1 is the first 2.x version.

.. _changelog-1.11.0:

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

Added
~~~~~

* Add support for task skipped errors via
``TransferClient.task_skipped_errors`` and
``TransferClient.endpoint_manager_task_skipped_errors`` (:pr:`393`)

Development
~~~~~~~~~~~

* Internal maintenance (:pr:`389`, :pr:`390`, :pr:`391`, :pr:`392`)

.. _changelog-1.10.0: