Metadata-Version: 2.1
Name: salt-nornir
Version: 0.11.0
Summary: Salt-Nornir Proxy Minion SaltStack Modules
Home-page: https://github.com/dmulyalin/salt-nornir
License: MIT
Keywords: Nornir,SaltStack,salt-extension
Author: Denis Mulyalin
Author-email: d.mulyalin@gmail.com
Maintainer: Denis Mulyalin
Maintainer-email: d.mulyalin@gmail.com
Requires-Python: >=3.6.5,<3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Provides-Extra: docs
Provides-Extra: prodmax
Provides-Extra: prodmin
Requires-Dist: Sphinx (==4.3.0); extra == "docs"
Requires-Dist: cerberus (==1.3.4); extra == "prodmax"
Requires-Dist: genie (==22.1); (sys_platform != "win32") and (extra == "prodmax")
Requires-Dist: jmespath (==0.10.0); extra == "prodmax"
Requires-Dist: napalm (==3.3.1); extra == "prodmax"
Requires-Dist: ncclient (==0.6.9); extra == "prodmin" or extra == "prodmax"
Requires-Dist: netmiko (==3.4.0); extra == "prodmin" or extra == "prodmax"
Requires-Dist: nornir (==3.2.0)
Requires-Dist: nornir-napalm (==0.1.2); extra == "prodmax"
Requires-Dist: nornir-netmiko (==0.1.2); extra == "prodmin" or extra == "prodmax"
Requires-Dist: nornir-scrapli (==2021.7.30); extra == "prodmax"
Requires-Dist: nornir_salt (>=0.11.0,<0.12.0)
Requires-Dist: ntc-templates (>=1.7.0,<2.0.0); extra == "prodmax"
Requires-Dist: paramiko (==2.9.2); extra == "prodmin" or extra == "prodmax"
Requires-Dist: pyats (==22.1); (sys_platform != "win32") and (extra == "prodmax")
Requires-Dist: pydantic (>=1.9.0,<1.10.0)
Requires-Dist: pygnmi (==0.6.8); extra == "prodmax"
Requires-Dist: pyyaml (==6.0); extra == "prodmax"
Requires-Dist: readthedocs-sphinx-search (==0.1.1); extra == "docs"
Requires-Dist: requests (==2.27.1); extra == "prodmin" or extra == "prodmax"
Requires-Dist: rich (==11.2.0); extra == "prodmin" or extra == "prodmax"
Requires-Dist: scrapli (==2021.7.30); extra == "prodmax"
Requires-Dist: scrapli-community (==2021.7.30); extra == "prodmax"
Requires-Dist: scrapli-netconf (==2022.1.30a1); extra == "prodmax"
Requires-Dist: sphinx_rtd_theme (==1.0.0); extra == "docs"
Requires-Dist: sphinxcontrib-applehelp (==1.0.1); extra == "docs"
Requires-Dist: sphinxcontrib-devhelp (==1.0.1); extra == "docs"
Requires-Dist: sphinxcontrib-htmlhelp (==2.0.0); extra == "docs"
Requires-Dist: sphinxcontrib-jsmath (==1.0.1); extra == "docs"
Requires-Dist: sphinxcontrib-napoleon (==0.7); extra == "docs"
Requires-Dist: sphinxcontrib-qthelp (==1.0.2); extra == "docs"
Requires-Dist: sphinxcontrib-serializinghtml (==1.1.5); extra == "docs"
Requires-Dist: sphinxcontrib-spelling (==7.2.1); extra == "docs"
Requires-Dist: tabulate (==0.8.9); extra == "prodmin" or extra == "prodmax"
Requires-Dist: ttp (==0.8.4); extra == "prodmin" or extra == "prodmax"
Requires-Dist: ttp-templates (>=0.1.0,<0.2.0); extra == "prodmin" or extra == "prodmax"
Requires-Dist: xmltodict (==0.12.0); extra == "prodmin" or extra == "prodmax"
Project-URL: Documentation, https://salt-nornir.readthedocs.io/
Project-URL: Repository, https://github.com/dmulyalin/salt-nornir
Description-Content-Type: text/markdown

[![Downloads][pepy-downloads-badge]][pepy-downloads-link]
[![PyPI][pypi-latest-release-badge]][pypi-latest-release-link]
[![PyPI versions][pypi-versions-badge]][pypi-versions-link]
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
[![Code style: black][black-badge]][black-link]
[![Documentation status][readthedocs-badge]][readthedocs-link]

![logo][logo]

# Salt Nornir

Repository to store Nornir based SaltStack modules:

- salt-nornir proxy minion module
- salt-nornir execution module
- salt-nornir state module
- salt-nornir runner module

Nornir Proxy Minion helps to manage network devices at scale, reference
[documentation](https://salt-nornir.readthedocs.io/en/latest/index.html)
for details.

# Architecture

Python and Plugins.

![architecture][architecture]

Nornir Proxy acts as a bridge between SaltStack and a wide set of network automation libraries.

# Advantages

Some notable benefits:

- Well tested - overall 500 tests for `salt-nornir` and `nornir-salt` packages combined as of release 0.10.0
- Brings together SaltStack and a wealth of open-source libraries - Nornir, Netmiko, NAPALM, Scrapli, Scrapli-Netconf, Ncclient, Genie&PyATS (free, not open-source), PyGNMI, NTC-Templates, TTP, Jmespath, lxml, xmltodict, requests
- Capable of addressing overwhelming set of use cases from simple data retrieval and parsing to infrastructure provisioning, testing, orchestration and self-healing
- Python is a first class citizen, need something special - write your own plugins, modules, scripts, codify your work flows
- Integrate anything with anything, all you can do via CLI you can do via SaltStack and Nornir Python API or SaltStack REST API

# Communication and discussion

Network To Code [salt-nornir Slack Channel](https://app.slack.com/client/T09LQ7E9E/C02MPR34DGF)

Open an [issue](https://github.com/dmulyalin/salt-nornir/issues)

Start a [discussion](https://github.com/dmulyalin/salt-nornir/discussions)

# Contributing

Issues, bug reports and feature requests are welcomed. Feedback is a gift and we truly value it.

# Authors Guidelines

- if it is not in the docs it does not exist
- if it is not tested it is broken
- done is better than perfect
- keep it stupid simple

[logo]:                        docs/source/_images/SaltNornirLogo.png "salt nornir logo"
[architecture]:                docs/source/_images/Nornir_proxy_minion_architecture_v2.png "salt nornir architecture"
[pepy-downloads-badge]:        https://pepy.tech/badge/salt-nornir
[pepy-downloads-link]:         https://pepy.tech/project/salt-nornir
[pypi-versions-badge]:         https://img.shields.io/pypi/pyversions/salt-nornir.svg
[pypi-versions-link]:          https://pypi.python.org/pypi/salt-nornir/
[readthedocs-badge]:           https://readthedocs.org/projects/salt-nornir/badge/?version=latest
[readthedocs-link]:            http://salt-nornir.readthedocs.io/?badge=latest
[pypi-latest-release-badge]:   https://img.shields.io/pypi/v/salt-nornir.svg
[pypi-latest-release-link]:    https://pypi.python.org/pypi/salt-nornir
[github-discussions-link]:     https://github.com/dmulyalin/salt-nornir/discussions
[github-discussions-badge]:    https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[black-badge]:                 https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]:                  https://github.com/psf/black
[github-tests-badge]:          https://github.com/dmulyalin/salt-nornir/actions/workflows/main.yml/badge.svg
[github-tests-link]:           https://github.com/dmulyalin/salt-nornir/actions

