pysepal.scripts.sepal_client.SepalClient

class pysepal.scripts.sepal_client.SepalClient(*, session_id=None, module_name=None, auth=None, base_url=None, timeout=30.0, verify=None)

pysepal_api.SepalClient plus the four legacy file verbs.

Each legacy verb delegates to self.files.* and emits a DeprecationWarning.

Attributes

Methods

get_file	Deprecated: download a file.
get_remote_dir	Create a remote directory (deprecated; use files.mkdir instead).
list_files	List files in a remote folder (deprecated; use files.list instead).
set_file	Write a file to the remote (deprecated; use files.write instead).

Parameters:

• session_id (str | None)

• module_name (str | None)

• auth (httpx.Auth | None)

• base_url (str | None)

• timeout (float | httpx.Timeout)

• verify (bool | None)

SepalClient.get_file(file_path, parse_json=False)

Deprecated: download a file. Use files.read_json / files.read_bytes.

Parameters:

• file_path (str)

• parse_json (bool)

Return type:

Any

SepalClient.get_remote_dir(folder, parents=False)

Create a remote directory (deprecated; use files.mkdir instead).

Parameters:

• folder (str | Path)

• parents (bool)

Return type:

PurePosixPath

SepalClient.list_files(folder='/', extensions=None)

List files in a remote folder (deprecated; use files.list instead).

Parameters:

• folder (str)

• extensions (Sequence[str] | None)

Return type:

dict[str, Any]

SepalClient.set_file(file_path, content, overwrite=False)

Write a file to the remote (deprecated; use files.write instead).

Parameters:

• file_path (str)

• content (str | bytes)

• overwrite (bool)

Return type:

dict[str, Any]