Skip to main content

Build Status Ruff Coverage Status

Nornir

logo

Nornir is a pure Python automation framework intented to be used directly from Python. While most automation frameworks use their own Domain Specific Language (DSL) which you use to describe what you want to have done, Nornir lets you control everything from Python.

One of the benefits we want to highlight with this approach is the ease of troubleshooting, if something goes wrong you can just use your existing debug tools directly from Python (just add a line of import pdb & pdb.set_trace() and you're good to go). Doing the same using a DSL can be quite time consuming.

What Nornir brings to the table is that it takes care of dealing with your inventory and manages the job of dispatching the tasks you want to run against your nodes and devices. The framework provides a very simple way to write plugins if you aren't happy with the ones we ship. Of course if you have written a plugin you think can be useful to others, please send us your code and test cases as a pull request.

Install

Please note that Nornir requires Python 3.10 or higher. Install Nornir with pip.

pip install nornir

Plugins

Since version 3.0.0 nornir doesn't ship with plugins, instead you can rely on pip to install them for you. You can find a non-exhaustive list of plugins here: https://nornir.readthedocs.io/en/latest/community/plugin_list.html

If you wrote a plugin and want to add it to the list don't hesitate to add it yourself

Development version

If you want to clone the repo and install it from there you will need to use uv.

Documentation

Read the Nornir documentation online or review its code here

External Resources

Below you can find links to talks, blog posts, podcasts and other resources:

Bugs & New features

If you think you have bug or would like to request a new feature, please register a GitHub account and open an issue.

Contact & Support

Official channel for communicating issues is via GitHub issues and you can use GitHub discussions for general discussions around nornir.

In addition, you can join the community in our #nornir channel in the OpsMill Discord server.

There's also a Slack channel in the networktoCode Slack team that's being monitored.

Contributing to Nornir

If you want to help the project, the Contribution Guidelines is the best place to start.

Release files for nornir 3.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nornir 3.6.0
File Size Uploaded
nornir-3.6.0.tar.gz 26.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nornir 3.6.0
File Interpreter ABI Platform
nornir-3.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 59.2 kB

Release files / nornir-3.6.0.tar.gz

Download URL nornir-3.6.0.tar.gz
Size 26.9 kB
Tags Source
SHA-256 checksum
How to use checksums
829e52b37cbe6c0454fc81b73b010f148f107d81e22b81db4583b570cce6f0e7
BLAKE2b-256 checksum
How to use checksums
62d48009ac1c8f8c7dfb5c0f28b631665d8f497bcaccc882ffc00809edf0051c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / nornir-3.6.0-py3-none-any.whl

Download URL nornir-3.6.0-py3-none-any.whl
Size 32.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
887da5e476cc00a36704aab98abfbe86e6bfedb0769c96ff786cf7b94a86ca4a
BLAKE2b-256 checksum
How to use checksums
cb1f8a778c5cd5a88d40d149de05c76f1eaa528ff185663747a87f1a2909ad37
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page