4.7.5.5. Setup environment variables¶
Tools for getting OS env vars.
- axonius_api_client.setup_env.LOGGER = <Logger axonius_api_client.setup_env (DEBUG)>¶
Logger to use
- axonius_api_client.setup_env.YES: List[str] = ['1', 'true', 't', 'yes', 'y', 'on']¶
Values that should be considered as truthy
- axonius_api_client.setup_env.NO: List[str] = ['0', 'false', 'f', 'no', 'n', 'off']¶
Values that should be considered as falsey
- axonius_api_client.setup_env.KEY_DEFAULT_PATH: str = 'AX_PATH'¶
OS env to use for
DEFAULT_PATH
instead of CWD
- axonius_api_client.setup_env.KEY_OVERRIDE: str = 'AX_ENV_OVERRIDE'¶
OS env to control ignoring OS env when loading .env file
- axonius_api_client.setup_env.KEY_FEATURES: str = 'AX_FEATURES'¶
OS env to get API features to enable from
- axonius_api_client.setup_env.KEY_CERTWARN: str = 'AX_CERTWARN'¶
OS env to get cert warning bool from
- axonius_api_client.setup_env.KEY_CERTPATH: str = 'AX_CERTPATH'¶
OS env to get cert warning bool from
- axonius_api_client.setup_env.KEY_DEBUG_PRINT: str = 'AX_DEBUG_PRINT'¶
OS env to use print() instead of LOGGER.debug()
- axonius_api_client.setup_env.KEY_USER_AGENT: str = 'AX_USER_AGENT'¶
OS env to use a custom User Agent string.
- axonius_api_client.setup_env.DEFAULT_DEBUG_PRINT: str = 'no'¶
Default for
KEY_DEBUG_PRINT
- axonius_api_client.setup_env.DEFAULT_OVERRIDE: str = 'yes'¶
Default for
KEY_OVERRIDE
- axonius_api_client.setup_env.DEFAULT_CERTWARN: str = 'yes'¶
Default for
KEY_CERTWARN
- axonius_api_client.setup_env.DEFAULT_ENV_FILE: str = '.env'¶
Default for
KEY_ENV_FILE
- axonius_api_client.setup_env.KEYS_HIDDEN: List[str] = ['AX_KEY', 'AX_SECRET']¶
List of keys to hide in
get_env_ax()
- axonius_api_client.setup_env.HIDDEN: str = '_HIDDEN_'¶
Value to use for hidden keys in
get_env_ax()
- axonius_api_client.setup_env.find_dotenv(ax_env=None, default='/home/docs/checkouts/readthedocs.org/user_builds/axonius-api-client/checkouts/latest/docs')[source]¶
Find a .env file.
- Parameters
ax_env (
typing.Union
[str
,pathlib.Path
,None
]) – manual path to look for .env filedefault (
str
) – default path to use ifKEY_DEFAULT_PATH
is not set
- Return type
Notes
Order of operations:
Check for ax_env for .env (or dir with .env in it)
Check for OS env var
KEY_ENV_PATH
for .env (or dir with .env in it)Check for OS env var
KEY_DEFAULT_PATH
as dir with .env in ituse dotenv.find_dotenv() to walk tree from CWD
use dotenv.find_dotenv() to walk tree from package root
- axonius_api_client.setup_env.load_dotenv(ax_env=None, **kwargs)[source]¶
Load a ‘.env’ file as environment variables accessible to this package.
- Parameters
ax_env (
typing.Union
[str
,pathlib.Path
,None
]) – path to .env file to load, if directory will look for ‘.env’ in that directory**kwargs – passed to dotenv.load_dotenv()
- Return type
- axonius_api_client.setup_env.get_env_bool(key, default=None)[source]¶
Get an OS env var and turn convert it to a boolean.
- Parameters
key (
str
) – OS env keydefault (
typing.Optional
[bool
]) – default to use if not found
- Raises
ValueError – OS env var value is not able to be converted to bool
- Return type
- axonius_api_client.setup_env.get_env_str(key, default=None, empty_ok=False, lower=False)[source]¶
Get an OS env var.
- Parameters
key (
str
) – OS env keydefault (
typing.Optional
[str
]) – default to use if not foundempty_ok (
bool
) – dont throw an exc if the key’s value is emptylower (
bool
) – lowercase the value
- Raises
ValueError – OS env var value is empty and empty_ok is False
- Return type
- axonius_api_client.setup_env.get_env_path(key, default=None, get_dir=True)[source]¶
Get a path from an OS env var.
- Parameters
key (
str
) – OS env var to get path fromdefault (
typing.Optional
[str
]) – default path to use if OS env var not setget_dir (
bool
) – return directory containing file of path is file
- Return type
- axonius_api_client.setup_env.get_env_csv(key, default=None, empty_ok=False, lower=False)[source]¶
Get an OS env var as a CSV.
- Parameters
key (
str
) – OS env keydefault (
typing.Optional
[str
]) – default to use if not foundempty_ok (
bool
) – dont throw an exc if the key’s value is emptylower (
bool
) – lowercase the value
- Return type
- axonius_api_client.setup_env.get_env_connect(**kwargs)[source]¶
Get URL, API key, API secret, and certwarn from OS env vars.
- Parameters
**kwargs – passed to
load_dotenv()
- Return type
- axonius_api_client.setup_env.get_env_features(**kwargs)[source]¶
Get list of features to enable from OS env vars.
- Parameters
**kwargs – passed to
load_dotenv()
- Return type
- axonius_api_client.setup_env.set_env(key, value, **kwargs)[source]¶
Set an environment variable in .env file.
- Parameters
- Return type
typing.Tuple
[str
,typing.Tuple
[bool
,str
,str
]]
- axonius_api_client.setup_env.DEBUG_USE(msg, *args, **kwargs)¶
use print or LOGGER.debug()
- axonius_api_client.setup_env.DEBUG_LOG(x)¶
Function to use for debug logging