nornir-rich-panelvar 0.2.0.post1

Fork of nornir-rich to support placing each individual nornir result var into its own dedicated rich panel (which in turn prettifies dictionary keys/values)

nornir_rich_panelvar

This is a fork of nornir-rich, I have published it separately as am not sure if the original package is still maintained (issue20) and need a way to enable the installation of my forked changes as a PyPI dependency.

• The per_panel_var branch (of changes) has been retained incase the package maintainer ever agrees to a PR for the changes in this fork
• Github actions are disabled in this fork as they fail on the first python version (3.8) due to an issue with poetry install

Extra features added by this fork

The following extra options can be set in the print_result method, the defaults keep the original nornir-rich behaviour:

• print_empty_task (default True): If set to False will not print a task if the task result is Null or an empty string ("")
• per_panel_var (default False): If set to True puts each individual nornir result var into its own dedicated rich panel. If the var is a dictionary rather than having the var name (for example result) within the panel it prettifies it to instead use the key for each dictionary item (all displayed in the one panel)

print_result(
    results,
    vars=["name", "result"],
    print_empty_task=False,
    per_panel_var=True,
)

Install

pip install nornir-rich

The rest of the README is from the original nornir_rich package

Usage

Features

• Print functions
  • print_result
  • print_failed_hosts
  • print_inventory
• Processors
  • progressbar

Print example

from nornir_rich.functions import print_result

results = nr.run(
    task=hello_world
)

print_result(results)
print_result(results, vars=["diff", "result", "name", "exception", "severity_level"])

Progress bar example

from time import sleep
from nornir_rich.progress_bar import RichProgressBar


def random_sleep(task: Task) -> Result:
    delay = randrange(10)
    sleep(delay)
    return Result(host=task.host, result=f"{delay} seconds delay")


nr_with_processors = nr.with_processors([RichProgressBar()])
result = nr_with_processors.run(task=random_sleep)

Images

Print Inventory

Print Result

Progress Bar

More examples