Buzio Package Reference¶
Submodules¶
buzio.cli module¶
Buzio main code.
This is the main code for Buzio Package It contains the Console class.
Return¶
- console (obj) = Console instance
- formatStr (obj) = Console instance with format_only=True
-
class
buzio.cli.Console(format_only=False, default_prefix='', default_transform='', default_theme='', theme_dict={'box': 'x1b[36m', 'choose': 'x1b[93m', 'confirm': 'x1b[95m', 'dark': 'x1b[37mx1b[2m', 'error': 'x1b[31m', 'info': 'x1b[36m', 'section': 'x1b[93m', 'success': 'x1b[32m', 'warning': 'x1b[33m'})¶ Console class.
- Attributes:
- DEFAULT_THEMES (Dict): Default color theme format_only (bool): Print or format string only prefix (bool): Append prefix on text? text (str): text to be formatted/printed theme (str): theme selected for print/format theme_dict (dict): theme dictionary loaded transform (str): keywords for transform text
-
DEFAULT_THEMES= {'box': '\x1b[36m', 'choose': '\x1b[93m', 'confirm': '\x1b[95m', 'dark': '\x1b[37m\x1b[2m', 'error': '\x1b[31m', 'info': '\x1b[36m', 'section': '\x1b[93m', 'success': '\x1b[32m', 'warning': '\x1b[33m'}¶
-
ask(obj, theme='warning', transform=None, humanize=True, validator=None, default=None, required=False, **kwargs)¶ Summary
- Args:
- obj (TYPE): Description theme (str, optional): Description transform (None, optional): Description humanize (bool, optional): Description validator (None, optional): Description default (None, optional): Description required (bool, optional): Description
- Returns:
- TYPE: Description
- Raises:
- ValueError: Description
-
box(obj, theme='box', transform=None, humanize=True, **kwargs)¶ Function: box Summary: InsertHere Examples: InsertHere
- Attributes:
- Returns: InsertHere
- Args:
- obj (TYPE): Description theme (str, optional): Description transform (None, optional): Description humanize (bool, optional): Description
- Returns:
- TYPE: Description
-
choose(choices, question=None, theme='choose', transform=None, humanize=True, default=None, **kwargs)¶ - Args:
- choices (TYPE): Description question (None, optional): Description theme (str, optional): Description transform (None, optional): Description humanize (bool, optional): Description default (None, optional): Description
- Returns:
- TYPE: Description
- Raises:
- ValueError: Description
-
clear()¶ Clear terminal.
-
confirm(obj=None, theme='confirm', transform=None, humanize=True, default=None, **kwargs)¶ - Args:
- obj (None, optional): Description theme (str, optional): Description transform (None, optional): Description humanize (bool, optional): Description default (None, optional): Description
- Returns:
- TYPE: Description
- Raises:
- ValueError: Description
-
error(obj, theme='error', transform=None, use_prefix=True, prefix='Error', humanize=True, **kwargs)¶ - Args:
- obj (TYPE): Description theme (str, optional): Description transform (None, optional): Description use_prefix (bool, optional): Description prefix (str, optional): Description humanize (bool, optional): Description
- Returns:
- TYPE: Description
-
info(obj, theme='info', transform=None, use_prefix=True, prefix='Info', humanize=True, **kwargs)¶ - Args:
- obj (TYPE): Description theme (str, optional): Description transform (None, optional): Description use_prefix (bool, optional): Description prefix (str, optional): Description humanize (bool, optional): Description
- Returns:
- TYPE: Description
-
load_theme(theme)¶ Function: load_theme Summary: InsertHere Examples: InsertHere
- Attributes:
- Returns: InsertHere
- Args:
- theme (TYPE): Description
- Raises:
- ValueError: Description
-
progress(count, total, prefix='Reading', theme=None, suffix='Complete', barLength=50, **kwargs)¶ - Args:
- count (TYPE): Description total (TYPE): Description prefix (str, optional): Description theme (None, optional): Description suffix (str, optional): Description barLength (int, optional): Description
- Returns:
- TYPE: Description
-
run(task, title=None, get_stdout=False, run_stdout=False, verbose=False, silent=False, use_prefix=True, prefix='Cmd')¶ Run command in subprocess.
- Args:
- task (string): command to run title (string, optional): title to be printed get_stdout (bool, optional): return stdout from command run_stdout (bool, optional): run stdout before command verbose (bool, optional): show command in terminal silent (bool, optional): occult stdout/stderr when running command
Bool or String: Task success or Task stdout
-
section(obj, theme='section', transform=None, use_prefix=False, prefix='Section', full_width=False, humanize=True, **kwargs)¶ - Args:
- obj (TYPE): Description theme (str, optional): Description transform (None, optional): Description use_prefix (bool, optional): Description prefix (str, optional): Description full_width (bool, optional): Description humanize (bool, optional): Description
- Returns:
- TYPE: Description
-
select(obj, theme='choose', humanize=True, question=None, default=None, **kwargs)¶ Summary
- Args:
- obj (TYPE): Description theme (str, optional): Description humanize (bool, optional): Description question (None, optional): Description default (None, optional): Description
- Returns:
- TYPE: Description
- Raises:
- ValueError: Description
-
slugify(obj, humanize=True, **kwargs)¶ Summary
- Args:
- obj (TYPE): Description humanize (bool, optional): Description
- Returns:
- TYPE: Description
-
success(obj, theme='success', transform=None, use_prefix=True, prefix='Success', humanize=True, **kwargs)¶ - Args:
- obj (TYPE): Description theme (str, optional): Description transform (None, optional): Description use_prefix (bool, optional): Description prefix (str, optional): Description humanize (bool, optional): Description
- Returns:
- TYPE: Description
-
unitext(obj, theme=None, transform=None, humanize=True, **kwargs)¶ Function: unitext Summary: InsertHere Examples: InsertHere
- Attributes:
- Returns: InsertHere
- Args:
- obj (TYPE): Description theme (None, optional): Description transform (None, optional): Description humanize (bool, optional): Description
- Returns:
- TYPE: Description
-
warning(obj, theme='warning', transform=None, use_prefix=True, prefix='Warning', humanize=True, **kwargs)¶ - Args:
- obj (TYPE): Description theme (str, optional): Description transform (None, optional): Description use_prefix (bool, optional): Description prefix (str, optional): Description humanize (bool, optional): Description
- Returns:
- TYPE: Description
-
buzio.cli.get_terminal_size()¶ Function: get_terminal_size.
Try to find terminal size using get_terminal_size on Python 3 and ‘tput’ commands for Python 2. Limited use on Windows: just returns (80, 25)
Tuple of Int: (col, lines)
Module contents¶
[summary]
[description]
- Variables:
- init() {[type]} – [description] __version__ {str} – [description] console {[type]} – [description] formatStr {[type]} – [description]