simdb.cli.remote_api module

exception simdb.cli.remote_api.APIError[source]

Bases: RuntimeError

exception simdb.cli.remote_api.FailedConnection[source]

Bases: APIError

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

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)[source]
delete(url: str, data: dict[Any, Any], **kwargs) → Response[source]

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)[source]
delete_simulation(**kwargs)[source]
get(url: str, params: dict | None = None, headers: dict | None = None, authenticate: bool | None = True, stream: bool | None = False) → Response[source]

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)[source]
get_directory(**kwargs)[source]
get_endpoints(**kwargs)[source]
get_server_authentication(**kwargs)[source]
get_server_version(**kwargs)[source]
get_simulation(**kwargs)[source]
get_token(**kwargs)[source]
get_upload_options(**kwargs)[source]
get_validation_schemas(**kwargs)[source]
has_url() → bool[source]
list_simulations(**kwargs)[source]
list_watchers(**kwargs)[source]
patch(url: str, data: dict, **kwargs) → Response[source]

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[source]

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)[source]
push_simulation(**kwargs)[source]
put(url: str, data: dict, **kwargs) → Response[source]

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)[source]
property remote : str

Return the name of the remote.

remove_watcher(**kwargs)[source]
reset_database(**kwargs)[source]
set_metadata(**kwargs)[source]
trace_simulation(**kwargs)[source]
update_simulation(**kwargs)[source]
validate_simulation(**kwargs)[source]
exception simdb.cli.remote_api.RemoteError[source]

Bases: APIError

simdb.cli.remote_api.check_return(res: Response) → None[source]
simdb.cli.remote_api.read_bytes(path: Path, compressed: bool = True) → bytes[source]
simdb.cli.remote_api.try_request(func: Callable) → Callable[source]