Client API Reference

The S2GOS client API is a thin wrapper around the Eozilla Client API called Cuiman that is provided by the Python package s2gos_client.

The entrypoint of the S2GOS client API is the create_client function. It creates an instance of the Client class that provides a synchronous API for interacting with the S2GOS processing service.

If you want an asynchronous client, use the create_async_client function instead. It creates an instance of AsyncClient with the same interface, but using asynchronous server calls.

Both clients return their configuration as a ClientConfig object.

Methods of the Client and AsyncClient may raise a s2gos_client.ClientError if a server call fails.

s2gos_client.create_client

create_client(**config: Any) -> Client

Create a synchronous S2GOS client from given configuration.

Provided configuration values, if any, override values read from persistent configuration that were previously written by the CLI command s2gos-client configure.

Parameters:

Name	Type	Description	Default
config	Any	Configuration overrides. See https://eo-tools.github.io/eozilla/cuiman/configuration/ for details.	{}

Returns: An instance of a synchronous cuiman client for S2GOS. See https://eo-tools.github.io/eozilla/cuiman/ for details.

s2gos_client.create_async_client

create_async_client(**config: Any) -> AsyncClient

Create an asynchronous S2GOS client from given configuration.

Provided configuration values, if any, override values read from persistent configuration that were previously written by the CLI command s2gos-client configure.

Parameters:

Name	Type	Description	Default
config	Any	Configuration overrides. See https://eo-tools.github.io/eozilla/cuiman/configuration/ for details.	{}

Returns: An instance of an asynchronous cuiman client for S2GOS. See https://eo-tools.github.io/eozilla/cuiman/ for details.