beautifish is a Python package that provides a set of utilities for decorating and enhancing the visual representation of data in the console, along with a collection of supported icons to make your console experience more delightful.
pip install beautifish- Console Data Decoration: Beautify your console output by using decorators to highlight, format and structure data.
- Pre-defined Templates: A collection of important templates to get started with, to put aside the worry of its UI.
- Supported Icons Library: A collection of icons to use in your console scripts or outputs.
A complete documentation will be out soon for the same.
You can install beautifish using pip:
pip install beautifishInitialize beautifish client and turn desired texts into colored shell texts:
import beautifish.decorators as bfd
import beautifish.colors as bfc# beautifish.decorators as bfd
s = "Beautiful fishes"
s = bfd.italic(s)
s = bfd.strikethrough(s)
# beautifish.colors as bfc
s = "Beautiful fishes"
s = bfc.blue_text(s)
s = bfc.green_text(s)Import and use from a plethora of useful templates for productivity and focusing on the work at hand:
import beautifish.templates as bft# show data as tree
data = {...}
bft.tree(data)
# color your inputs
age = bft.input("Enter age:")
# create loading bar
bft.loading_bar(iterations=40,msg="Downloading")
# create ascii text banner
bft.banner("Beautifish",color="yellow")Import and use all supported shell icons out-of-the-box:
import beautifish.icons as bfi
msg = f"{bfi.TICK} Correct answer"
err = f"{bfi.WARNING} Sure to proceed?"All supported icons:
TICK, CROSS, DOT, WARNING, ARROW_DOWN, ARROW_UP, ARROW_LEFT, ARROW_RIGHT, ARROW_RIGHT2, SPARKLE, STAR, CLOCK, DANGER, DASH, CHECK, LIGHTNING, HOURGLASS
Contributions are welcome!
If you have ideas for improvements, new features, or bug fixes, please feel free to open an issue or submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
