Skip to main content

Scrapli's plugin for Nornir

Project description

Supported Versions PyPI version Weekly Build Code Style License: MIT

nornir_scrapli


Documentation: https://scrapli.github.io/nornir_scrapli

Source Code: https://github.com/scrapli/nornir_scrapli

Examples: https://github.com/scrapli/nornir_scrapli/tree/master/examples


nornir_scrapli -- scrapli's plugin for nornir

Key Features:

  • Easy: It's easy to get going with scrapli -- check out the documentation and example links above, and you'll be connecting to devices in no time.
  • Fast: Do you like to go fast? Of course you do! All of scrapli is built with speed in mind, but if you really feel the need for speed, check out the ssh2 transport plugin to take it to the next level!
  • Great Developer Experience: scrapli has great editor support thanks to being fully typed; that plus thorough docs make developing with scrapli a breeze.
  • Well Tested: Perhaps out of paranoia, but regardless of the reason, scrapli has lots of tests! Unit tests cover the basics, regularly ran functional tests connect to virtual routers to ensure that everything works IRL!
  • Pluggable: scrapli provides a pluggable transport system -- don't like the currently available transports, simply extend the base classes and add your own! Need additional device support? Create a simple "platform" in scrapli_community to easily add new device support!
  • But wait, there's more!: Have NETCONF devices in your environment, but love the speed and simplicity of scrapli? You're in luck! Check out scrapli_netconf!

Requirements

MacOS or *nix1, Python 3.7+

1 Although many parts of scrapli do run on Windows, Windows is not officially supported

Installation

pip install nornir-scrapli

See the docs for other installation methods/details.

A simple Example

from nornir import InitNornir
from nornir_scrapli.tasks import send_command


nr = InitNornir(config_file="nornir_data/config.yaml")
command_results = nr.run(task=send_command, command="show version")

print("send_command result:")
print(command_results["iosxe-1"].result)

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

nornir_scrapli-2024.7.30.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

nornir_scrapli-2024.7.30-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

Details for the file nornir_scrapli-2024.7.30.tar.gz.

File metadata

  • Download URL: nornir_scrapli-2024.7.30.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for nornir_scrapli-2024.7.30.tar.gz
Algorithm Hash digest
SHA256 d81a888384ae4b307acaa605a59ec0efacd75a9392809a04a987b526beed7bbe
MD5 0f6d19b790b46ed7ff912da7a625ef23
BLAKE2b-256 70db472bff4dae7aa946380fb61121e0e035ad6f1adac3346d6004494d5aa7b0

See more details on using hashes here.

File details

Details for the file nornir_scrapli-2024.7.30-py3-none-any.whl.

File metadata

File hashes

Hashes for nornir_scrapli-2024.7.30-py3-none-any.whl
Algorithm Hash digest
SHA256 84ab7297bf5c350b6e3bba9772a55b892d32b1373eb47d17dd65630f3b372948
MD5 e605b607b2db24fbe5ea5ec97307b8b9
BLAKE2b-256 d8c7cdad68a872c878ca7c117d7160260583c8b2c3070a91439c32e57a039e5c

See more details on using hashes here.

Supported by

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