Helpers for command line interaces (CLI) in terminal
Project description
Read the Docs: http://buzio.readthedocs.io/
Source Code: https://github.com/chrismaille/buzio
Buzio is a python library tool for printing formatted text in terminal, similar to termcolor or colored.
Installing Buzio
Install Buzio using the command:
$ pip install buzio
Importing the Library
from buzio import console, formatStr
The console is a instance of the Console class initialized with default color themes. You can also import the class and instantiate with your own settings (See the :doc:reference for more info)
The formatStr is also a instance of the Console class too, but instead of printing in terminal the message, this instance just return the formatted text.
The default color themes
Method |
Text Color |
---|---|
console.box |
Fore.CYAN |
console.error |
Fore.RED |
console.info |
Fore.CYAN |
console.section |
Fore.LIGHTYELLOW_EX |
console.success |
Fore.GREEN |
console.warning |
Fore.YELLOW |
These colors are based in colorama constants.
Generate fancy formats
“Section” example 1:
from buzio import console
console.section("First Section")
Terminal output:
$ >> First Section $ ----------------
Humanize Python objects
Buzio can automatically humanize any python object for printing in terminal:
from datetime import datetime, timedelta
from buzio import console
today = datetime.now()
yesterday = today - timedelta(days=1)
my_dict = {
"start day": yesterday,
"end day": today
}
console.box(my_dict, date_format="%a, %b-%d-%Y")
The output on terminal will be (in blue color):
$ ********************************* $ * * $ * start day: Thu, Feb-01-2018 * $ * end day: Fri, Feb-02-2018 * $ * * $ *********************************
Ask for Input data
You can use Buzio to automatically generate “choose” and “select” questions, based on Python objects:
“Choose” example:
from buzio import console
my_choices = [
"Orange",
"Apple",
"Potato"
]
console.choose(my_choices)
Terminal output:
$ 1. Orange $ 2. Apple $ 3. Potato $ $ Select (1-3): ?
Run terminal commands
You can use Buzio to run terminal commands (using Python subprocess) and get the stdout result:
>>> from buzio import console >>> ret = console.run("echo HelloWorld!", get_stdout=True, verbose=True) Cmd: echo HelloWorld! >>> print(ret) HelloWorld!
Further reading
Please check full documentation in http://buzio.readthedocs.io/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for buzio-1.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e94a471bfca992c6910ff7034ad6e54e1ef8803ba5484aa8073c4a4e6772360e |
|
MD5 | 4bbb749ab498f88b17035a47bc26ae0c |
|
BLAKE2b-256 | 2a31ef0c01d6b41039513539094a7e6f7e210bf890560b32962300281aa962fd |