nornir-scrapli


Namenornir-scrapli JSON
Version 2024.7.30 PyPI version JSON
download
home_pageNone
SummaryScrapli's plugin for Nornir
upload_time2024-07-30 14:34:21
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2021 Carl Montanari Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords arista automation cisco eos iosxe iosxr juniper junos netconf network nxos ssh telnet
VCS
bugtrack_url
requirements nornir nornir_utils ntc_templates scrapli scrapli_cfg scrapli_community scrapli_netconf textfsm
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Supported Versions](https://img.shields.io/pypi/pyversions/scrapli.svg)](https://pypi.org/project/nornir_scrapli)
[![PyPI version](https://badge.fury.io/py/scrapli.svg)](https://badge.fury.io/py/nornir_scrapli)
[![Weekly Build](https://github.com/scrapli/nornir_scrapli/workflows/Weekly%20Build/badge.svg)](https://github.com/scrapli/nornir_scrapli/actions?query=workflow%3A%22Weekly+Build%22)
[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![License: MIT](https://img.shields.io/badge/License-MIT-blueviolet.svg)](https://opensource.org/licenses/MIT)

nornir_scrapli
==============

---

**Documentation**: <a href="https://scrapli.github.io/nornir_scrapli" target="_blank">https://scrapli.github.io/nornir_scrapli</a>

**Source Code**: <a href="https://github.com/scrapli/nornir_scrapli" target="_blank">https://github.com/scrapli/nornir_scrapli</a>

**Examples**: <a href="https://github.com/scrapli/nornir_scrapli/tree/master/examples" target="_blank">https://github.com/scrapli/nornir_scrapli/tree/master/examples</a>

---

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](https://github.com/scrapli/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](https://github.com/scrapli/scrapli_netconf)!


## Requirements

MacOS or \*nix<sup>1</sup>, Python 3.7+

<sup>1</sup> Although many parts of scrapli *do* run on Windows, Windows is not officially supported


## Installation

```
pip install nornir-scrapli
```

See the [docs](https://scrapli.github.io/nornir_scrapli/user_guide/installation) for other installation methods/details.



## A simple Example

```python
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)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nornir-scrapli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "arista, automation, cisco, eos, iosxe, iosxr, juniper, junos, netconf, network, nxos, ssh, telnet",
    "author": null,
    "author_email": "Carl Montanari <carl.r.montanari@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/70/db/472bff4dae7aa946380fb61121e0e035ad6f1adac3346d6004494d5aa7b0/nornir_scrapli-2024.7.30.tar.gz",
    "platform": null,
    "description": "[![Supported Versions](https://img.shields.io/pypi/pyversions/scrapli.svg)](https://pypi.org/project/nornir_scrapli)\n[![PyPI version](https://badge.fury.io/py/scrapli.svg)](https://badge.fury.io/py/nornir_scrapli)\n[![Weekly Build](https://github.com/scrapli/nornir_scrapli/workflows/Weekly%20Build/badge.svg)](https://github.com/scrapli/nornir_scrapli/actions?query=workflow%3A%22Weekly+Build%22)\n[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blueviolet.svg)](https://opensource.org/licenses/MIT)\n\nnornir_scrapli\n==============\n\n---\n\n**Documentation**: <a href=\"https://scrapli.github.io/nornir_scrapli\" target=\"_blank\">https://scrapli.github.io/nornir_scrapli</a>\n\n**Source Code**: <a href=\"https://github.com/scrapli/nornir_scrapli\" target=\"_blank\">https://github.com/scrapli/nornir_scrapli</a>\n\n**Examples**: <a href=\"https://github.com/scrapli/nornir_scrapli/tree/master/examples\" target=\"_blank\">https://github.com/scrapli/nornir_scrapli/tree/master/examples</a>\n\n---\n\nnornir_scrapli -- scrapli's plugin for nornir\n\n\n#### Key Features:\n\n- __Easy__: It's easy to get going with scrapli -- check out the documentation and example links above, and you'll be \n  connecting to devices in no time.\n- __Fast__: Do you like to go fast? Of course you do! All of scrapli is built with speed in mind, but if you really \n  feel the need for speed, check out the `ssh2` transport plugin to take it to the next level!\n- __Great Developer Experience__: scrapli has great editor support thanks to being fully typed; that plus thorough \n  docs make developing with scrapli a breeze.\n- __Well Tested__: Perhaps out of paranoia, but regardless of the reason, scrapli has lots of tests! Unit tests \n  cover the basics, regularly ran functional tests connect to virtual routers to ensure that everything works IRL! \n- __Pluggable__: scrapli provides a pluggable transport system -- don't like the currently available transports, \n  simply extend the base classes and add your own! Need additional device support? Create a simple \"platform\" in \n  [scrapli_community](https://github.com/scrapli/scrapli_community) to easily add new device support!\n- __But wait, there's more!__: Have NETCONF devices in your environment, but love the speed and simplicity of \n  scrapli? You're in luck! Check out [scrapli_netconf](https://github.com/scrapli/scrapli_netconf)!\n\n\n## Requirements\n\nMacOS or \\*nix<sup>1</sup>, Python 3.7+\n\n<sup>1</sup> Although many parts of scrapli *do* run on Windows, Windows is not officially supported\n\n\n## Installation\n\n```\npip install nornir-scrapli\n```\n\nSee the [docs](https://scrapli.github.io/nornir_scrapli/user_guide/installation) for other installation methods/details.\n\n\n\n## A simple Example\n\n```python\nfrom nornir import InitNornir\nfrom nornir_scrapli.tasks import send_command\n\n\nnr = InitNornir(config_file=\"nornir_data/config.yaml\")\ncommand_results = nr.run(task=send_command, command=\"show version\")\n\nprint(\"send_command result:\")\nprint(command_results[\"iosxe-1\"].result)\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2021 Carl Montanari  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Scrapli's plugin for Nornir",
    "version": "2024.7.30",
    "project_urls": {
        "Docs": "https://scrapli.github.io/nornir_scrapli/",
        "Homepage": "https://github.com/scrapli/nornir_scrapli"
    },
    "split_keywords": [
        "arista",
        " automation",
        " cisco",
        " eos",
        " iosxe",
        " iosxr",
        " juniper",
        " junos",
        " netconf",
        " network",
        " nxos",
        " ssh",
        " telnet"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d8c7cdad68a872c878ca7c117d7160260583c8b2c3070a91439c32e57a039e5c",
                "md5": "e605b607b2db24fbe5ea5ec97307b8b9",
                "sha256": "84ab7297bf5c350b6e3bba9772a55b892d32b1373eb47d17dd65630f3b372948"
            },
            "downloads": -1,
            "filename": "nornir_scrapli-2024.7.30-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e605b607b2db24fbe5ea5ec97307b8b9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 33154,
            "upload_time": "2024-07-30T14:34:19",
            "upload_time_iso_8601": "2024-07-30T14:34:19.397428Z",
            "url": "https://files.pythonhosted.org/packages/d8/c7/cdad68a872c878ca7c117d7160260583c8b2c3070a91439c32e57a039e5c/nornir_scrapli-2024.7.30-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "70db472bff4dae7aa946380fb61121e0e035ad6f1adac3346d6004494d5aa7b0",
                "md5": "0f6d19b790b46ed7ff912da7a625ef23",
                "sha256": "d81a888384ae4b307acaa605a59ec0efacd75a9392809a04a987b526beed7bbe"
            },
            "downloads": -1,
            "filename": "nornir_scrapli-2024.7.30.tar.gz",
            "has_sig": false,
            "md5_digest": "0f6d19b790b46ed7ff912da7a625ef23",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 19197,
            "upload_time": "2024-07-30T14:34:21",
            "upload_time_iso_8601": "2024-07-30T14:34:21.901384Z",
            "url": "https://files.pythonhosted.org/packages/70/db/472bff4dae7aa946380fb61121e0e035ad6f1adac3346d6004494d5aa7b0/nornir_scrapli-2024.7.30.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-30 14:34:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "scrapli",
    "github_project": "nornir_scrapli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "nornir",
            "specs": [
                [
                    ">=",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "nornir_utils",
            "specs": [
                [
                    ">=",
                    "0.1.0"
                ]
            ]
        },
        {
            "name": "ntc_templates",
            "specs": [
                [
                    ">=",
                    "1.1.0"
                ]
            ]
        },
        {
            "name": "scrapli",
            "specs": [
                [
                    ">=",
                    "2022.01.30"
                ]
            ]
        },
        {
            "name": "scrapli_cfg",
            "specs": [
                [
                    ">=",
                    "2022.01.30"
                ]
            ]
        },
        {
            "name": "scrapli_community",
            "specs": [
                [
                    ">=",
                    "2021.01.30"
                ]
            ]
        },
        {
            "name": "scrapli_netconf",
            "specs": [
                [
                    ">=",
                    "2022.01.30"
                ]
            ]
        },
        {
            "name": "textfsm",
            "specs": [
                [
                    ">=",
                    "1.1.0"
                ]
            ]
        }
    ],
    "lcname": "nornir-scrapli"
}
        
Elapsed time: 9.52702s