Home

CLI Functions

cls

Clears the terminal

userInputMenu

    Args:
        menyOptions (List)          # A list containing all of the available option to choose in the menu.
        menyName    (Str)  optional # The name of the menu. Defaults to "".
        wrapAround  (Bool) optional # Dictates if you can "wrap around" the menu. ex last item to first or vise versa. Defaults to False.
        returnInt   (Bool) optional # Dictates if to return the index of the selected meny Items instead of string. Defaults to False.
        clearOnExit (Bool) optional # Clear the menu on exit. Defaults to True.

    Returns:
        String or Integer # Returns the string of selected item unless returnInt is true then it returns a Integer depending on the selected item.

userInput

    Args:
        questionMessage (String)           # The message that should be asked to the user.
        inputType       (String)           # A string that indicates what type of data that should be returned
        minVal          (Integer) optional # If inputType == Int you can set the minimun value that the user needs to input. Defaults to None.

    Returns:
        Any # Returns the same Variable Type as specified in inputType

ID generators

randomString

    Args:
        Length    (Int)           # The length of the random string
        Uppercase (Bool) optional # Dictats whenever the string should have uppercase letters or not. Defaults to True.
        Lowercase (Bool) optional # Dictats whenever the string should have undercase letters or not. Defaults to True.
        Numbers   (Bool) optional # Dictats whenever the string should have numbers or not. Defaults to True.
        Symbols   (Bool) optional # Dictats whenever the string should have symbols or not. Defaults to True.

    Returns:
        String # Returns a random string

fastRandomString

    # Removes Unnessery ifs and whatnot therefor its "Fast"

    Args:
        Length (Integer) # Length of the random string

    Returns:
        String # returns a random string