Skip to main content

A workflow orchestration tool for network automation built around Nornir.

Project description

NornFlow

CI Python Versions License PyPI version Linter: Ruff Style: black Imports: isort Installer: uv

NornFlow is still in the prototype phase.

NornFlow leverages the power of Nornir, a Python framework for network automation, to execute tasks on network devices.

NornFlow serves two main purposes:

  • a CLI-wrapper around Nornir, allowing users to invoke the execution of individual Nornir tasks.
  • an Ansible-like workflow automation tool that enables users to build and execute complex workflows through YAML files (or programmatically through its API).

Why Use NornFlow?

NornFlow provides benefits that make it a compelling choice for network automation for both developers and non-developers alike:

💪 Real power for developers: Since NornFlow is built on Nornir, developers can deliver network automation directly in Python by writing Nornir tasks as straightforward Python functions. This eliminates the need for convoluted boilerplate code to create new 'plugins'.

👍 Simplicity for end-users: Engineers who are familiar with Ansible but not as proficient in Python and network automation development will find NornFlow’s user experience familiar and accessible. End-users can trigger and define their network automation workflows using intuitive YAML files, much like Ansible playbooks.

For installation and usage, see 'Getting Started'.

Quick Start

  • Getting Started
  • Configurations:
    • NonrFlow Settings file
    • Nornir Configuration file
  • The NornFLow class
  • The WorkFlow class
  • The CLI
  • Supported Features
  • Feature Roadmap

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nornflow-0.1.0.tar.gz (72.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nornflow-0.1.0-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

Details for the file nornflow-0.1.0.tar.gz.

File metadata

  • Download URL: nornflow-0.1.0.tar.gz
  • Upload date:
  • Size: 72.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.24

File hashes

Hashes for nornflow-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cb020a9dcf6f2ed9b162e40a236891288237ab14afcefb8799216ed423a31a19
MD5 0fa01594203beb88aca40e474b33d3ed
BLAKE2b-256 e8fd00cafb6108cccf4372e173a9e01c1062b8f6fac598d61cbc301fc21ae4ef

See more details on using hashes here.

File details

Details for the file nornflow-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: nornflow-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 38.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.24

File hashes

Hashes for nornflow-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 49e2cdcc94494ce8e7a4423df044c742695a10f3a6f402796fed66f0cabd4196
MD5 69e6839c12ed185b136141f6d8e30ce0
BLAKE2b-256 c47d6f22e76a97ff6d7a8832ab07172f87448cad35928b7c814adeb8b987f912

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page