Skip to content

VITObelgium/terracatalogueclient

Repository files navigation

TerraCatalogueClient

TerraCatalogueClient is a Python client for the Terrascope EO catalogue. This client uses the OpenSearch REST service of the catalogue and makes it easier to query and download EO data products in Python.

More information about the OpenSearch interface can be found in the Terrascope Documentation.

Documentation

Information on the usage of the Python client and a full API overview can be found in the package documentation.

Installation

This package is available in PyPI and the public Terrascope repository and can be installed using pip. When you are using a Terrascope Virtual Machine (VM) or Notebooks, the package is already pre-installed for you.

From PyPI

$ pip install terracatalogueclient

From the Terrascope repository

  • add the Terrascope PyPi repository in your pip configuration file
    [global]
    extra-index-url = https://artifactory.vgt.vito.be/artifactory/api/pypi/python-packages/simple
  • install the terracatalogueclient package
    $ pip install terracatalogueclient

Or provide the Terrascope PyPi repository directly to the installation command:

$ pip install --extra-index-url https://artifactory.vgt.vito.be/artifactory/api/pypi/python-packages/simple terracatalogueclient

Development

Building the docs

Install the documentation dependencies:

$ pip install -e .[docs]

Build the documentation:

$ cd docs/
$ make html