Python library to decorate and beautify strings

Last update: Dec 13, 2022

Related tags

Miscellaneous outputformater

Overview

outputformater

Python library to decorate and beautify your standard output 💖

Installation

To get the latest version, simply use pip:

pip install outputformater

There are no dependencies.

Python>=3.6 is needed, as it uses f strings.

Basic usage

It is recommended to use ouf as shortcut for outputformater:

import outputformater as ouf

Main functions are:

ouf.boxtitle
ouf.linetitle
ouf.bigtitle
ouf.showlist
ouf.bar
ouf.barlist

By default, functions print the result. You have the alternative to return a string instead, by passing the argument return_str=True (nothing will be printed in this case).

Showing titles

To decorate titles with a box around it, use ouf.boxtitle:

ouf.boxtitle("Long title in a box")

╭─────────────────────╮
│ Long title in a box │
╰─────────────────────╯

Boxes can have different styles:

ouf.boxtitle("Box with 'line' style", style="line")
ouf.boxtitle("Box with 'double' style", style="double")
ouf.boxtitle("Box with 'dashes' style", style="dashes")

╭───────────────────────╮
│ Box with 'line' style │
╰───────────────────────╯
╔═════════════════════════╗
║ Box with 'double' style ║
╚═════════════════════════╝
╭╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╮
┊ Box with 'dashes' style ┊
╰╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╯

Or you can pass any character and it will be used for the decoration:

ouf.boxtitle("Box with custom character as style", style="ø")

øøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøø
ø Box with custom character as style ø
øøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøøø

With all the same options as for boxtitle, you can use linetitle for a simple line underneath your text:

ouf.linetitle("Long title with 'double' underline", style="double")

Long title with 'double' underline
══════════════════════════════════

Big title

It is possible to use ASCII art to generate big titles:

outputstring = ouf.bigtitle("Here's a big title!")

█ █ █▀▀ █▀█ █▀▀ ▀ █▀   ▄▀█   █▄▄ █ █▀▀   ▀█▀ █ ▀█▀ █   █▀▀ █ 
█▀█ ██▄ █▀▄ ██▄   ▄█   █▀█   █▄█ █ █▄█    █  █  █  █▄▄ ██▄ ▄

Currently, only one font is available, and the supported characters are: "0123456789abcdefghijklmnopqrstuvwxyz_-!.' "

(You can get them by using ouf.fonts.suported_chars)

Showing lists

You can simply show a list using bullet points:

data = ["Item A", "Item B", "Item C", "Item D"]
ouf.showlist(data)

• Item A
• Item B
• Item C
• Item D

And also there's an option to add a title to your list:

data = ["Item A", "Item B", "Item C", "Item D"]
ouf.showlist(data, title="List of items")

List of items
• Item A
• Item B
• Item C
• Item D

Different styles are available, as bullet, line, box and ordinal

data = ["Item A", "Item B", "Item C", "Item D"]

ouf.showlist(data, style="line", title="Style line")
ouf.showlist(data, style="box", title="Style box")
ouf.showlist(data, style="ordinal", title="Style ordinal")

 Style line
╭──────────
├ Item A
├ Item B
├ Item C
╰ Item D

╭───────────╮
│ Style box │
├───────────╯
├ Item A
├ Item B
├ Item C
╰ Item D

Style ordinal
1. Item A
2. Item B
3. Item C
4. Item D

Or pass any string to be used as marker

data = ["Item A", "Item B", "Item C", "Item D"]
ouf.showlist(data, style="~>", title="Custom style list")

Custom style list
~> Item A
~> Item B
~> Item C
~> Item D

Showing bars

You can create a simple horizontal bar using ouf.bar The first parameter (value) is the filled amount, the second (maxvalue) is the maximum amount

ouf.bar(35, 50)

▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░ 35/50 ( 70.00%)

Note that there's some integer rounding needed to create the bar, so the size is not precise, more like a ballpark visualisation.

The size of the bar (in characters) is defined by length

ouf.bar(35, 50, length=10)
ouf.bar(35, 50, length=50)

▓▓▓▓▓▓▓░░░ 35/50 ( 70.00%)
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░░░░░ 35/50 ( 70.00%)

Different styles are available, as well as the option to have a title before the bar:

ouf.bar(35, 50, style="block", length=15, title="Block style", title_pad=15)
ouf.bar(35, 50, style="battery", length=15,title="Battery style", title_pad=15)
ouf.bar(35, 50, style="bar", length=15, title="Bar style", title_pad=15)
ouf.bar(35, 50, style="circle", length=15, title="Circle style", title_pad=15)

Block style....: ▓▓▓▓▓▓▓▓▓▓░░░░░ 35/50 ( 70.00%)

Battery style..: ┫██████████     ┣ 35/50 ( 70.00%)

Bar style......: [■■■■■■■■■■     ] 35/50 ( 70.00%)

Circle style...: ●●●●●●●●●●○○○○○ 35/50 ( 70.00%)

There's also a star emoji style, that works better with small values for length and using show_percentage=False and show_values=False

ouf.bar(60, 100, style="star", length=5, title="Item A", show_percentage=False, show_values=False)
ouf.bar(20, 100, style="star", length=5, title="Item B", show_percentage=False, show_values=False)
ouf.bar(90, 100, style="star", length=5, title="Item C", show_percentage=False, show_values=False)

Item A: ⭐⭐⭐
Item B: ⭐
Item C: ⭐⭐⭐⭐

Custom bars

A totally custom style for the bar can be created, passing a list of characters as style

ouf.bar(35, 50, style=["(", "X", "-", ")"], title="Custom style")

Custom style: (XXXXXXXXXXXXXXXXXXXXXX----------) 35/50 ( 70.00%)

Or you can pass just a simple character, and it will be used for a basic bar:

ouf.bar(35, 50, style="$", title="Custom style")

Custom style: [$$$$$$$$$$$$$$$$$$$$$$          ] 35/50 ( 70.00%)

Multiple bars from list

It is possible to use ouf.barlist and pass directly a list of values with the correspondent list of titles

values = [6, 3, 13, 8]
titles = ["var", "long var name", "medium var", "one more"]
ouf.barlist(values, titles, maxvalue=15, style="bar")

var..........: [■■■■■■■■■■■■                    ]  6/15 ( 40.00%)
long var name: [■■■■■■                          ]  3/15 ( 20.00%)
medium var...: [■■■■■■■■■■■■■■■■■■■■■■■■■■■     ] 13/15 ( 86.67%)
one more.....: [■■■■■■■■■■■■■■■■■               ]  8/15 ( 53.33%)

The same parameters from ouf.bar can be used. Only one maxvalue is used for all the lists

Show emoji

Some shortcuts for the unicode values of common emoji are available

print(ouf.emoji.heart, ouf.emoji.thumbs_up)

💖 👍

Current shortcuts are the following:

crazy.............:🤪
sad...............:😥
circle_red........:🔴
circle_orange.....:🟠
circle_yellow.....:🟡
circle_green......:🟢
circle_white......:⚪
circle_black......:⚫
star..............:⭐
heart.............:💖
thumbs_up.........:👍
check.............:✅
clap..............:👏
bomb..............:💣

🔩 Like builtins, but boltons. 250+ constructs, recipes, and snippets which extend (and rely on nothing but) the Python standard library. Nothing like Michael Bolton.

Boltons boltons should be builtins. Boltons is a set of over 230 BSD-licensed, pure-Python utilities in the same spirit as — and yet conspicuously mis

5.4k Feb 20, 2021

App and Python library for parsing, writing, and validation of the STAND013 file format.

python-stand013 python-stand013 is a Python app and library for parsing, writing, and validation of the STAND013 file format. Features The following i

3 Nov 9, 2022

This Python library searches through a static directory and appends artist, title, track number, album title, duration, and genre to a .json object

This Python library searches through a static directory (needs to match your environment) and appends artist, title, track number, album title, duration, and genre to a .json object. This .json object is then used to post data to a specified table in a local MySQL database, credentials of which the user must set.

1 Jun 20, 2022

PREFS is a Python library to store and manage preferences and settings.

PREFS PREFS is a Python library to store and manage preferences and settings. PREFS stores a Python dictionary in a total human-readable file, the PRE

13 May 26, 2022

TextColor - An easy to use Python library which allows you to make your terminal outputs more colorful and therefore easier to read and understand

This is an easy to use Python library which allows you to make your terminal out

1 Feb 5, 2022

Simple, high-school-leveled sequence library written in Python / 간단한 고등학교 수준 수열 라이브러리 (Python)

Simple, high-school-leveled sequence library written in Python

1 Dec 8, 2021

Ikaros is a free financial library built in pure python that can be used to get information for single stocks, generate signals and build prortfolios

64 Sep 28, 2022

Python library and cli util for https://www.zerochan.net/

Zerochan Library for Zerochan.net with pics parsing and downloader included! Features CLI utility for pics downloading from zerochan.net Library for c

10 Oct 11, 2022

Datargsing is a data management and manipulation Python library

Datargsing What is It? Datargsing is a data management and manipulation Python library which is currently in deving Why this library is good? This Pyt

10 Oct 24, 2022

Comments

New big font

New style for bigtitle :point_right: big

for style in ouf.fonts.font_styles:
    outputstring = ouf.bigtitle(f"style: {style}", style=style)

opened by delestro 0

Basic colors

added color functionality

Examples:

ouf.boxtitle("Box title here", color="rainbow", cmap="cool", bold=True)

ouf.bigtitle("big title in color", color="#9030BA")

ouf.bigtitle("big title in color", color="#9030BA")

ouf.c("Hello!", "red" , bold=True)

for cmap in ouf.color.cmaps:
    ouf.b(cmap)
    ouf.rainbow("▇"*50, cmap=cmap)
    ouf.br(2)

opened by delestro 0

basic showdict

ouf.showdict added:

data = {"Variable0001": 42,
        "Var2": [24, 32, 64.00000000001, "string"],
        "Variable3": False,
        "V4": [39.032323423525623, 23.68],
        "Var5": [42, -43, 29],
        "Vari6": 39,
         }

ouf.showdict(data, style="box", title="Title here", precision=2)

╭────────────╮
│ Title here │
├────────────╯
├ Variable0001: 42
├ V4..........: 24, 32, 64.00, string
├ Variable3...: False
├ Var2........: 39.03, 23.68
├ Variable3...: +42, -43, +29
╰ Vari6.......: 39

opened by delestro 0

Fix empty values for barlist

barlist was breaking in case NaNs or None was given. Now works as expected:

values = [np.nan, 24, None, 10]
titles = ["VarA", np.nan, "VarCCCC", None]

ouf.barlist(values, titles=titles, maxvalue=100)

Gives as output:

VarA...: 
nan....: [■■■■■■■                         ]  24.00/100.00 ( 24.00%)
VarCCCC: 
None...: [■■■                             ]  10.00/100.00 ( 10.00%)

opened by delestro 0

Releases(v0.1.3)

v0.1.3(Jan 30, 2022)
New features for v0.1.3:

Show dictionaries using ouf.showdict

Bold text using ouf.b

Color text with ouf.c

Break several lines using ouf.br

New 'big' style for ouf.bigtitle

Basic colormaps implemented ouf.color.cmaps

Rainbow text that follows a cmap using ouf.rainbow

Source code(tar.gz)
Source code(zip)
v0.1.2(Jan 8, 2022)
Now handling better negative values, they are also aligned in case present.

Added option to select precision for floats

Added "?" to supported chars

Source code(tar.gz)
Source code(zip)
v0.1.1(Dec 28, 2021)

Source code(tar.gz)
Source code(zip)
v0.1.0(Dec 27, 2021)

Source code(tar.gz)
Source code(zip)

Python library to decorate and beautify strings

Related tags

Overview

outputformater

Installation

Basic usage

Showing titles

Big title

Showing lists

Showing bars

Custom bars

Multiple bars from list

Show emoji

You might also like...

🔩 Like builtins, but boltons. 250+ constructs, recipes, and snippets which extend (and rely on nothing but) the Python standard library. Nothing like Michael Bolton.

App and Python library for parsing, writing, and validation of the STAND013 file format.

This Python library searches through a static directory and appends artist, title, track number, album title, duration, and genre to a .json object

PREFS is a Python library to store and manage preferences and settings.

TextColor - An easy to use Python library which allows you to make your terminal outputs more colorful and therefore easier to read and understand

Simple, high-school-leveled sequence library written in Python / 간단한 고등학교 수준 수열 라이브러리 (Python)

Ikaros is a free financial library built in pure python that can be used to get information for single stocks, generate signals and build prortfolios

Python library and cli util for https://www.zerochan.net/

Datargsing is a data management and manipulation Python library

Comments

New big font

Basic colors

basic showdict

Fix empty values for barlist

Releases(v0.1.3)

v0.1.3(Jan 30, 2022)

v0.1.2(Jan 8, 2022)

v0.1.1(Dec 28, 2021)

v0.1.0(Dec 27, 2021)

Owner

Felipe Delestro Matos

🏆 A ranked list of awesome Python open-source libraries and tools. Updated weekly.

Capture screen and download off Roku based devices

SEH-Helper - Binary Ninja plugin for exploring Structured Exception Handlers

Buffer Overflows

CalHacks 8 Repo: Megha Jain, Gaurav Bhatnagar, Howard Meng, Vibha Tantry

ARRU seismic backprojection - Earthquake waveform detection and P/S arrivals picking on continuous data using ARRU phase picker

Script de monitoramento de telemetria para missões espaciais, cansat e foguetemodelismo.

Sabe is a python framework written for easy web server setup.

Runtime fault injection platform by Daniele Rizzieri (2021)

Run unpatched binaries on Nix/NixOS

Linux Backlight Manager

Fortnite StW Claimer for Daily Rewards, Research Points and free Llamas.

A deployer and package manager for OceanBase open-source software.

Generate Openbox Menus from a easy to write configuration file.

Stopmagic gives you the power of creating amazing Stop Motion animations faster and easier than ever before.

Percolation simulation using python

A webapp for taking fast notes, designed for business, school, and collaboration with groups.

Decoupled Smoothing in Probabilistic Soft Logic

适用于HoshinoBot下的雀魂插件。可进行近期对局查询、查询个人数据等功能，更多功能正在扩展

E-Paper display loop with plugins