Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 3.35 KB

README.md

File metadata and controls

79 lines (53 loc) · 3.35 KB
Raw

Supported Versions PyPI version Weekly Build Code Style License: MIT

scrapli_community

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

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

This is the scrapli_community repository for scrapli.

If you would like to use scrapli, but the platform(s) that you work with are not supported in the "core" scrapli platforms, you have come to the right place! This library is intended to be a place for scrapli users to add additional platform support to scrapli.

Please see the main scrapli repo for much more information about the main project.

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 -- this repo! to easily add new device support!
  • Concurrency on Easy Mode: Nornir's scrapli plugin gives you all the normal benefits of scrapli plus all the great features of Nornir.

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 scrapli-community

See the docs for other installation methods/details.

A simple Example

from scrapli import Scrapli

my_device = {
    "host": "172.18.0.11",
    "auth_username": "scrapli",
    "auth_password": "scrapli",
    "auth_strict_key": False,
    "platform": "ruckus_fastiron"
}

conn = Scrapli(**my_device)
conn.open()