simdb.cli.remote_api module

exception simdb.cli.remote_api.APIError

Bases: RuntimeError

exception simdb.cli.remote_api.FailedConnection

Bases: APIError

class simdb.cli.remote_api.RemoteAPI(remote: str | None, username: str | None, password: str | None, config: Config, use_token: bool | None = None)

Bases: object

Class to represent connection to remote API.

This is used by the CLI to make all requests to the remote.

add_watcher(**kwargs)

delete(url: str, data: Dict[Any, Any], **kwargs) → Response

Perform an HTTP DELETE request.

@param url: the URL of the request. @param data: the DELETE data to send. @param kwargs: any additional keyword arguments to add to the request. @return:

delete_metadata(**kwargs)

delete_simulation(**kwargs)

get(url: str, params: Dict | None = None, headers: Dict | None = None, authenticate: bool | None = True, stream: bool | None = False) → Response

Perform an HTTP GET request.

@param url: the URL of the request. @param params: any additional parameters to send along with the request. @param headers: additional headers to send with the request. @param authenticate: True if we should send authentication headers with the request. @param stream: True to enable streaming. @return:

get_api_version(**kwargs)

get_directory(**kwargs)

get_endpoints(**kwargs)

get_server_authentication(**kwargs)

get_server_version(**kwargs)

get_simulation(**kwargs)

get_token(**kwargs)

get_upload_options(**kwargs)

get_validation_schemas(**kwargs)

has_url() → bool

list_simulations(**kwargs)

list_watchers(**kwargs)

patch(url: str, data: Dict, **kwargs) → Response

Perform an HTTP PATCH request.

@param url: the URL of the request. @param data: the PATCH data to send. @param kwargs: any additional keyword arguments to add to the request. @return:

post(url: str, data: Dict, **kwargs) → Response

Perform an HTTP POST request.

@param url: the URL of the request. @param data: the POST data to send. @param kwargs: any additional keyword arguments to add to the request. @return:

pull_simulation(**kwargs)

push_simulation(**kwargs)

put(url: str, data: Dict, **kwargs) → Response

Perform an HTTP PUT request.

@param url: the URL of the request. @param data: the PUT data to send. @param kwargs: any additional keyword arguments to add to the request. @return:

query_simulations(**kwargs)

property remote: str

Return the name of the remote.

remove_watcher(**kwargs)

reset_database(**kwargs)

set_metadata(**kwargs)

trace_simulation(**kwargs)

update_simulation(**kwargs)

validate_simulation(**kwargs)

exception simdb.cli.remote_api.RemoteError

Bases: APIError

simdb.cli.remote_api.check_return(res: Response) → None

simdb.cli.remote_api.read_bytes(path: str, compressed: bool = True) → bytes

simdb.cli.remote_api.try_request(func: Callable) → Callable