Catalog Client

CatalogClient

The CatalogClient handles the HTTP communication with the Descartes Labs catalog.
class CatalogClient(url=None, auth=None, retries=None)[source]

The CatalogClient handles the HTTP communication with the Descartes Labs catalog. It is almost sufficient to use the default client that is automatically retrieved using get_default_client. However, if you want to adjust e.g. the retries, you can create your own.

Parameters:

  • url (str, optional) – The URL to use when connecting to the Descartes Labs catalog. Only change this if you are being asked to use a non-default Descartes Labs catalog. If not set, then descarteslabs.config.get_settings().CATALOG_V2_URL will be used.

  • auth (Auth, optional) – The authentication object used when connecting to the Descartes Labs catalog. This is typically the default Auth object that uses the cached authentication token retrieved with the shell command “$ descarteslabs auth login”.

  • retries (int, optional) – The number of retries when there is a problem with the connection. Set this to zero to disable retries. The default is 3 retries.

classmethod get_default_client()

Retrieve the default client.

This client is used whenever you don’t explicitly set the client.

classmethod set_default_client(client)

Change the default client to the given client.

This is the client that will be used whenever you don’t explicitly set the client