Skip to content

Client

cdse.client.Client

Client(
    auth: AuthProvider,
    *,
    settings: Settings | None = None,
    store: TokenStore | None = None,
)

Entry point for talking to the Copernicus Data Space Ecosystem APIs.

Parameters:

Name Type Description Default
auth AuthProvider

The authentication provider describing how to obtain tokens.

required
settings Settings | None

Optional configuration; sensible defaults are used otherwise.

None
store TokenStore | None

Optional token store; tokens are kept in memory by default.

None

The client owns an :class:httpx.Client and should be closed when finished, either explicitly with :meth:close or by using it as a context manager.

s3 property

s3: S3Client

Direct S3 access to the product archive.

Requires S3 credentials in the settings and the optional s3 extra.

close

close() -> None

Close the underlying HTTP connection pool.