UsgsApi

UsgsApi#

class eodag.plugins.apis.usgs.UsgsApi(provider, config)[source]#

A plugin that enables to query and download data on the USGS catalogues

Parameters:

  • provider (str) – provider name

  • config (PluginConfig) –

    Api plugin configuration:

    • type (str) (mandatory): UsgsApi

    • pagination (Pagination) (mandatory): object containing parameters for pagination; should contain the attribute total_items_nb_key_path which is indicating the key for the number of total items in the provider result

    • ssl_verify (bool): if the ssl certificates should be verified in the download request; default: True

    • need_auth (bool): if authentication is required for search; default: False

    • extract (bool): if the content of the downloaded file should be extracted; default: True

    • order_enabled (bool): if the product has to be ordered to download it; default: False

    • metadata_mapping (dict[str, Union[str, list]]): how parameters should be mapped between the provider and eodag; If a string is given, this is the mapping parameter returned by provider -> eodag parameter. If a list with 2 elements is given, the first one is the mapping eodag parameter -> provider query parameters and the second one the mapping provider result parameter -> eodag parameter

__init__(provider, config)[source]#
Parameters:

Methods

__init__(provider, config)

authenticate()

Login to usgs api

build_sort_by(sort_by_arg)

Build the sorting part of the query string or body by transforming the sort_by argument into a provider-specific string or dictionary

clear()

Method used to clear a search context between two searches.

discover_collections(**kwargs)

Fetch collections list from provider using discover_collections conf

discover_queryables(**kwargs)

Fetch queryables list from provider using discover_queryables conf

download(product[, auth, progress_callback, ...])

Download data from USGS catalogues

download_all(products[, auth, ...])

Base download_all method.

generate_record_hash(product)

Generate the record hash of the given product.

get_assets_from_mapping(provider_item)

Create assets based on the assets_mapping in the provider's config and an item returned by the provider

get_collection_cfg_dates([start_default, ...])

Get start and end dates from the collection configuration.

get_collection_cfg_value(key[, default])

Get the value of a configuration option specific to the current collection.

get_collection_def_params(collection[, ...])

Get the provider collection definition parameters and specific settings

get_metadata_mapping([collection])

Get the plugin metadata mapping configuration (collection specific if exists)

get_sort_by_arg(kwargs)

Extract the sort_by argument from the kwargs or the provider default sort configuration

list_queryables(filters, ...[, collection, ...])

Get queryables

map_collection(collection, **kwargs)

Get the provider collection from eodag collection

query([prep])

Search for data on USGS catalogues

queryables_from_metadata_mapping([...])

Extract queryable parameters from collection metadata mapping.

stream_download(product[, auth, byte_range, ...])

Base stream_download method.

validate(search_params, auth)

Validate a search request.

Attributes

plugins

auth

next_page_url

next_page_query_obj

total_items_nb

need_count