What is Cerbose?

Cerbose is a simple, cross-platform Python library that allows for fancy terminal text output and additional console-related features.

Showcase

Presented to you is an image of a test script, showcasing the following functions in Cerbose:

• cprint — Tagged text, such as the [OK]: text preceding messages.
• cerbar — A simple progress bar function, like the [############--------] in the message with the [STAT] tag.
• cquery — A simple function to take ✨stylish✨ user input in the terminal, such as the [WARN][INFO]: Give feedback on the frogs.: with an input spot.

Where to Get Cerbose?

Get Cerbose and more information on it at:

• The GitHub repository
• The PyPI project
• The documentation

Functions

cprint

cprint is Cerbose's main function; it outputs highly configurable, tagged text to the terminal. cprint has the following options in each call:

• NOTE: The documentation has more information.
• Required:
• type: The tag the output uses.
• text: The actual text in the output.
• Optional:
• log_file: Logs the output to a specified file.
• text_colour: Changes the colour of the text.
• subtag: Adds a second tag to the output.
• timestamp: Adds a timestamp preceding the tags in the output.
• as_string: Returns a value containing the output instead of printing it.

mprint

mprint is essentially the same function as cprint, except it supports multiline output.

cerbar

cerbar is a function that can easily make ASCII progress bars to output in the terminal. cerbar has the following options in each call:

• NOTE: The documentation has more information.
• Required:
• length: How many characters long the bar is (not including borders).
• total: The total value the bar represents (unshaded and shaded).
• fill: How much of the total is filled in (NOT A PERCENTAGE).
• Optional:
• percent: Adds the percentage filled either before or after the progress bar.
• count: Adds a counter (fill/total) either before or after the progress bar.

cquery

cquery (formerly cin) is a function to take stylised user input. It returns what the user inputted. cquery has the following options in each call:

• NOTE: The documentation has more information.
• Required:
• textis the same as in cprint and tag is the same as type in cprint.
• options: The possible options that can be inputted (or '*' for any input).
• Optional:
• log_file, text_colour, subtag, and timestamp are the same as in cprint.
• lower: Recieves user input in lowercase.
• show_opts: If False, hides options from 'o'/'opt' mode..

Other

Cerbose has other functions, however these are the main, meaningful functions.

Configuration

Cerbose's config variables allow the following to be configured:

• Tag colours.
• Tag text.
• Custom tags.
• Symbols (e.g., brackets in tags/cerbar, fill-in in cerbar, etc.)
• Space repeat tolerance (how many times alignment settings can repeat before Cerbose tries to reset it)
• Time format in timestamps.

Language & Base

Cerbose is made in Python and uses the colorama library.