Metadata-Version: 2.4
Name: nornir-utils
Version: 0.3.0
Summary: Collection of plugins and functions for nornir that don't require external dependencies
Author: David Barroso
Author-email: David Barroso <dbarrosop@dravetech.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: nornir>=3.0.0a0,<4
Requires-Dist: colorama>=0.4.3,<0.5
Requires-Python: >=3.10
Project-URL: Repository, https://github.com/nornir-automation/nornir-utils
Description-Content-Type: text/x-rst

.. image:: https://img.shields.io/badge/docs-passing-green.svg
   :target: https://nornir.tech/nornir-utils/
   :alt: Documentation

.. image:: https://github.com/nornir-automation/nornir-utils/workflows/test_nornir_utils/badge.svg
   :target: https://github.com/nornir-automation/nornir-utils/actions?query=workflow%3Atest_nornir_utils
   :alt: test_nornir_utils

nornir_utils
============

Collection of simple plugins for `nornir <https://github.com/nornir-automation/nornir/>`_

Installation
------------

.. code::

    pip install nornir_utils

Plugins
-------

Inventory
_________

* **YAMLInventory** - Create an inventory from yaml files
* **load_credentials** - Transform function to load credentials from venv

Functions
_________

* **print_result** - Formats nicely and prints results on stdout.
* **print_title** - Formats nicely a title and prints it on stdout.

Processors
__________

* **PrintResult** - Formats nicely and prints results on stdout as soon as they are made available.

Tasks
_____

Data:

* **echo_data** - Dummy task that echoes the data passed to it.
* **load_json** - Load a JSON file.
* **load_yaml** - Load a YAML file.

Files:

* **write_file** - Writes content to files

Networking:

* **tcp_ping** - Tests connection to a tcp port.
