keyup.cauth module

Module List


keyup.cli module

Module List


keyup.colors module

Summary:
ANSI color and formatting code class See: http://www.lihaoyi.com/post/BuildyourownCommandLinewithANSIescapecodes.html#256-colors
Args:
None
Returns:
ansi codes
Raises:
None. AttributeError if no code match returns the reset ansi codes
class keyup.colors.Colors[source]

Bases: object

Class attributes provide different format variations

AQUA = '\x1b[38;5;14m'
BKGND_BLACK = '\x1b[40m'
BKGND_BLUE = '\x1b[44m'
BKGND_BRIGHT_BLACK = '\x1b[40;1m'
BKGND_BRIGHT_BLUE = '\x1b[44;1m'
BKGND_BRIGHT_CYAN = '\x1b[46;1m'
BKGND_BRIGHT_GREEN = '\x1b[42;1m'
BKGND_BRIGHT_MAGENTA = '\x1b[45;1m'
BKGND_BRIGHT_RED = '\x1b[41;1m'
BKGND_BRIGHT_WHITE = '\x1b[47;1m'
BKGND_BRIGHT_YELLOW = '\x1b[43;1m'
BKGND_CYAN = '\x1b[46m'
BKGND_GREEN = '\x1b[42m'
BKGND_MAGENTA = '\x1b[45m'
BKGND_RED = '\x1b[41m'
BKGND_WHITE = '\x1b[47m'
BKGND_WHITE_BOLD = '\x1b[47;1m'
BKGND_YELLOW = '\x1b[43m'
BLUE = '\x1b[94m'
BOLD = '\x1b[1m'
BRIGHTBLUE = '\x1b[38;5;51m'
BRIGHTCYAN = '\x1b[38;5;36m'
BRIGHTGREEN = '\x1b[38;5;95;38;5;46m'
BRIGHTPURPLE = '\x1b[38;5;68m'
BRIGHTRED = '\x1b[31;1m'
BRIGHTWHITE = '\x1b[38;5;15m'
BRIGHTYELLOW = '\x1b[38;5;11m'
BRIGHTYELLOW2 = '\x1b[38;5;95;38;5;226m'
BRIGHTYELLOWGREEN = '\x1b[38;5;95;38;5;155m'
CYAN = '\x1b[96m'
DARKBLUE = '\x1b[38;5;95;38;5;24m'
DARKCYAN = '\x1b[36m'
DARKGRAY1 = '\x1b[90m'
DARKGRAY2 = '\x1b[38;5;95;38;5;8m'
DARKGREEN = '\x1b[38;5;2m'
END = '\x1b[0m'
GREEN = '\x1b[92m'
ITALIC = '\x1b[3m'
LT1GRAY = '\x1b[38;5;95;38;5;245m'
LT2GRAY = '\x1b[38;5;249m'
ORANGE = '\x1b[38;5;95;38;5;214m'
PURPLE = '\x1b[95m'
RED = '\x1b[91m'
RESET = '\x1b[0;0m'
REVERSE = '\x1b[;7m'
TITLE = '\x1b[4m\x1b[1m'
UNBOLD = '\x1b[22m'
UNDERLINE = '\x1b[4m'
URL = '\x1b[4m\x1b[96m'
WHITE = '\x1b[37m'
WHITEGRAY = '\x1b[38;5;95;38;5;250m'
YELLOW = '\x1b[93m'

Module List


keyup.configuration module

Module List


keyup.help_menu module

Module List


keyup.keyconfig module

Module List


keyup.logd module

Summary:
Project-level logging module
keyup.logd.getLogger(*args, **kwargs)[source]
Summary:
custom format logger
Args:

mode (str): The Logger module supprts the following log modes:

  • log to console / stdout. Log_mode = ‘stream’
  • log to file
  • log to system logger (syslog)
Returns:
logging object | TYPE: logging singleton
keyup.logd.logprep(mode)[source]
Summary:
prerequisites for logging to file mode
Args:
mode (str):valid value is ‘FILE’; parameter used for logging type validation only
Return:
Success | Failure, TYPE: bool
keyup.logd.mode_assignment(mode)[source]

Translates arg to enforce proper assignment

Module List


keyup.map module

Module List


keyup.menu module

Curses-menu

keyup.menu.main()[source]

Builds main menu, branches to submenus

keyup.menu.selection_menu_example()[source]
keyup.menu.submenu_backup(menu_obj)[source]
keyup.menu.submenu_logging(menu_obj)[source]

Module List


keyup.progress module

Module List


keyup.statics module

Summary.

keyup Project-level Defaults and Settings

  • Local Default Settings: Local defaults for your specific installation are derived from settings found in:
~/.config/keyup/config.json
Module Attributes:
  • user_home (TYPE str):

    $HOME environment variable, present for most Unix and Unix-like POSIX systems

  • config_dir (TYPE str):

    directory name default for stsaval config files (.stsaval)

  • config_path (TYPE str):

    default for stsaval config files, includes config_dir (~/.stsaval)

  • key_deprecation (TYPE str):

    Deprecation logic that keyup uses when 2 keys exist for a user.

    2 values possible:

    • ‘AGE’: keyup deprecates based on age, replacing the oldest key
    • ‘AWSCLI’: keyup replaces keys currently in the local awscli config
keyup.statics.get_os(detailed=False)[source]
Summary:
Retrieve local operating system environment characteristics
Args:
user (str):USERNAME, only required when run on windows os
Returns:
TYPE: dict object containing key, value pairs describing os information
keyup.statics.import_file_object(filename)[source]
Summary:
Imports block filesystem object
Args:
filename (str):block filesystem object
Returns:
dictionary obj (valid json file), file data object
keyup.statics.os_parityPath(path)[source]

Converts unix paths to correct windows equivalents. Unix native paths remain unchanged (no effect)

keyup.statics.read_local_config(cfg)[source]

Parses local config file for override values

Args:
local_file (str):
 filename of local config file
Returns:
dict object of values contained in local config file

Module List


keyup.thread_progress module

Module List


keyup.iam_operations module

Module List


keyup.list_ops module

Module List


keyup.script_utils module

Module List


keyup.oscodes_unix module

Standard OS Module Exit Codes
Module Attributes:
  • exit_codes (dict): exit error codes for Unix, Linux

Module List


keyup.oscodes_win module

Standard OS Module Exit Codes
Module Attributes:
  • exit_codes (dict): exist error codes for Microsoft Windows

Module List


Table Of Contents