Skip to main content

Easily add support for 'non-core' platforms to scrapli

Project description

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()

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

scrapli_community-2025.1.30.tar.gz (33.1 kB view details)

Uploaded Source

Built Distribution

scrapli_community-2025.1.30-py3-none-any.whl (93.1 kB view details)

Uploaded Python 3

File details

Details for the file scrapli_community-2025.1.30.tar.gz.

File metadata

  • Download URL: scrapli_community-2025.1.30.tar.gz
  • Upload date:
  • Size: 33.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for scrapli_community-2025.1.30.tar.gz
Algorithm Hash digest
SHA256 5357d1e471879203f648948adf114d8155a69ca1242060504d9b92f54f79d119
MD5 ebca50acc058f94e61274e9596d2c787
BLAKE2b-256 9229b5df286b9cb143f1e95b7824a8ba1ebb0fc7606b96a0a50a62fc50cf3858

See more details on using hashes here.

File details

Details for the file scrapli_community-2025.1.30-py3-none-any.whl.

File metadata

File hashes

Hashes for scrapli_community-2025.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 dc4d02193ec3bb14cec9e04ab0d48fc59d575e1ccedac92fb4b8bbd6f3b6726f
MD5 adccf2cc449adebc9b6afe173945f084
BLAKE2b-256 2367c0c0d088a786fcaa3e0584a765f1da00b0560dadc7f0ea8c8755b7d175f3

See more details on using hashes here.

Supported by

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