# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-nornir-rich
VERSION=		0.1.6
KEYWORDS=		python
VARIANTS=		v11 v12
SDESC[v11]=		Pretty display functions for nornir (3.11)
SDESC[v12]=		Pretty display functions for nornir (3.12)
HOMEPAGE=		https://github.com/InfrastructureAsCode-ch/nornir_rich
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/72/33/0c7aeece275ec17869d1bef10dd2f9e31ef8e8f23a491c96abe45e87207a
DISTFILE[1]=		nornir_rich-0.1.6-py3-none-any.whl:main
DF_INDEX=		1
SPKGS[v11]=		single
SPKGS[v12]=		single

OPTIONS_AVAILABLE=	PY311 PY312
OPTIONS_STANDARD=	none
VOPTS[v11]=		PY311=ON PY312=OFF
VOPTS[v12]=		PY311=OFF PY312=ON

DISTNAME=		nornir_rich-0.1.6.dist-info

GENERATED=		yes

[PY311].RUN_DEPENDS_ON=			python-nornir:single:v11
					python-rich:single:v11
[PY311].USES_ON=			python:v11,wheel

[PY312].RUN_DEPENDS_ON=			python-nornir:single:v12
					python-rich:single:v12
[PY312].USES_ON=			python:v12,wheel

[FILE:951:descriptions/desc.single]
# nornir_rich

## Install

```bash
pip install nornir-rich
```

## Usage

Features

- Print functions
  - `print_result`
  - `print_failed_hosts`
  - `print_inventory`
- Processors
  - `progressbar`

### Print example

```python
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

```python
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 inventory]

### Print Result

![Print Result]

### Progress Bar

![Progress Bar]

More [examples]


[FILE:113:distinfo]
221d72fe16234a414bcf611610ca269407dd56fb33714f027e3cf8739db8717f         5664 nornir_rich-0.1.6-py3-none-any.whl