Module macrobond_data_api.util.save_proxy_to_keyring

Functions

def save_proxy_to_keyring(warn_before_removing: bool = True, test_proxy: bool = True) ‑> bool

Create or update a proxy in the system's keyring interactively via the terminal.

Parameters

warn_before_removing : bool
Optional bool whether the method should ask before removing keys, default to True.
test_proxy : bool
Optional bool whether the method should test proxy before saving, default to True.

Returns

bool returns True if the key was successful created or update in the keyring.

Remarks

Note

It's easy to run this method via the terminal.

python -c "from macrobond_data_api.util import *; save_proxy_to_keyring()"

Caution

This method can remove proxy setting in your keyring, but it will ask first unless warn_before_removing is set to False.