scrapli-community


Namescrapli-community JSON
Version 2024.1.30 PyPI version JSON
download
home_page
SummaryEasily add support for 'non-core' platforms to scrapli
upload_time2024-01-29 02:28:07
maintainer
docs_urlNone
author
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 No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Supported Versions](https://img.shields.io/pypi/pyversions/scrapli.svg)](https://pypi.org/project/scrapli)
[![PyPI version](https://badge.fury.io/py/scrapli-community.svg)](https://badge.fury.io/py/scrapli-community)
[![Weekly Build](https://github.com/scrapli/scrapli_community/workflows/Weekly%20Build/badge.svg)](https://github.com/scrapli/scrapli_community/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)

scrapli_community
=================

---

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

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

---


This is the scrapli_community repository for [scrapli](https://github.com/carlmontanari/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](https://github.com/carlmontanari/scrapli) 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!](https://github.com/scrapli/scrapli_community) to easily add new device support!
- __Concurrency on Easy Mode__: [Nornir's](https://github.com/nornir-automation/nornir) 
  [scrapli plugin](https://github.com/scrapli/nornir_scrapli) gives you all the normal benefits of scrapli __plus__ 
  all the great features of Nornir.


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

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



## A simple Example

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "scrapli-community",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "arista,automation,cisco,eos,iosxe,iosxr,juniper,junos,netconf,network,nxos,ssh,telnet",
    "author": "",
    "author_email": "Carl Montanari <carl.r.montanari@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ac/6a/cd0d9669ea7aeef64d481d83e4021ae36f660db74b000f808a762760bd44/scrapli_community-2024.1.30.tar.gz",
    "platform": null,
    "description": "[![Supported Versions](https://img.shields.io/pypi/pyversions/scrapli.svg)](https://pypi.org/project/scrapli)\n[![PyPI version](https://badge.fury.io/py/scrapli-community.svg)](https://badge.fury.io/py/scrapli-community)\n[![Weekly Build](https://github.com/scrapli/scrapli_community/workflows/Weekly%20Build/badge.svg)](https://github.com/scrapli/scrapli_community/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\nscrapli_community\n=================\n\n---\n\n**Documentation**: <a href=\"https://scrapli.github.io/scrapli_community\" target=\"_blank\">https://scrapli.github.io/scrapli_community</a>\n\n**Source Code**: <a href=\"https://github.com/scrapli/scrapli_community\" target=\"_blank\">https://github.com/scrapli/scrapli_community</a>\n\n---\n\n\nThis is the scrapli_community repository for [scrapli](https://github.com/carlmontanari/scrapli).\n\nIf you would like to use scrapli, but the platform(s) that you work with are not supported in the \"core\" scrapli\n platforms, you have come to the right place! This library is intended to be a place for scrapli users to add\n  additional platform support to scrapli.\n \nPlease see the main [scrapli repo](https://github.com/carlmontanari/scrapli) for much more information about the main\n project.\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 -- this repo!](https://github.com/scrapli/scrapli_community) to easily add new device support!\n- __Concurrency on Easy Mode__: [Nornir's](https://github.com/nornir-automation/nornir) \n  [scrapli plugin](https://github.com/scrapli/nornir_scrapli) gives you all the normal benefits of scrapli __plus__ \n  all the great features of Nornir.\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 scrapli-community\n```\n\nSee the [docs](https://scrapli.github.io/scrapli_community/user_guide/installation) for other installation methods/details.\n\n\n\n## A simple Example\n\n```python\nfrom scrapli import Scrapli\n\nmy_device = {\n    \"host\": \"172.18.0.11\",\n    \"auth_username\": \"scrapli\",\n    \"auth_password\": \"scrapli\",\n    \"auth_strict_key\": False,\n    \"platform\": \"ruckus_fastiron\"\n}\n\nconn = Scrapli(**my_device)\nconn.open()\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": "Easily add support for 'non-core' platforms to scrapli",
    "version": "2024.1.30",
    "project_urls": {
        "Changelog": "https://scrapli.github.io/scrapli_community/changelog/",
        "Docs": "https://scrapli.github.io/scrapli_community/",
        "Homepage": "https://github.com/scrapli/scrapli_community"
    },
    "split_keywords": [
        "arista",
        "automation",
        "cisco",
        "eos",
        "iosxe",
        "iosxr",
        "juniper",
        "junos",
        "netconf",
        "network",
        "nxos",
        "ssh",
        "telnet"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7bdc1a4e9403b5c7baad33aca81340e113cd3c7f263a9c63fc476e96e9f463c4",
                "md5": "fe0675fe0b8fd1ac14d334e380ee0a52",
                "sha256": "6a88d11a6b588e2ccc7f08683fd4a66f5a47016cddbe4481f60b646d9c0b6570"
            },
            "downloads": -1,
            "filename": "scrapli_community-2024.1.30-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fe0675fe0b8fd1ac14d334e380ee0a52",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 84361,
            "upload_time": "2024-01-29T02:28:06",
            "upload_time_iso_8601": "2024-01-29T02:28:06.032938Z",
            "url": "https://files.pythonhosted.org/packages/7b/dc/1a4e9403b5c7baad33aca81340e113cd3c7f263a9c63fc476e96e9f463c4/scrapli_community-2024.1.30-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ac6acd0d9669ea7aeef64d481d83e4021ae36f660db74b000f808a762760bd44",
                "md5": "3a9be67e2ba84a1c16827c6df5a71df0",
                "sha256": "20e5655a15fe4cbe7d8cfd83c64ff0758f80610d6a14333dce59e3ac265ce6c1"
            },
            "downloads": -1,
            "filename": "scrapli_community-2024.1.30.tar.gz",
            "has_sig": false,
            "md5_digest": "3a9be67e2ba84a1c16827c6df5a71df0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 29889,
            "upload_time": "2024-01-29T02:28:07",
            "upload_time_iso_8601": "2024-01-29T02:28:07.188035Z",
            "url": "https://files.pythonhosted.org/packages/ac/6a/cd0d9669ea7aeef64d481d83e4021ae36f660db74b000f808a762760bd44/scrapli_community-2024.1.30.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-29 02:28:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "scrapli",
    "github_project": "scrapli_community",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "scrapli-community"
}
        
Elapsed time: 0.20256s