| Name | scrapli JSON |
| Version |
2024.1.30
JSON |
| download |
| home_page | |
| Summary | Fast, flexible, sync/async, Python 3.7+ screen scraping client specifically for network devices |
| upload_time | 2024-01-29 02:39:12 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| 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. |
| 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.
|
<p center><a href=""><img src=https://github.com/carlmontanari/scrapli/blob/main/scrapli.svg?sanitize=true/></a></p>
[](https://pypi.org/project/scrapli)
[](https://badge.fury.io/py/scrapli)
[](https://github.com/carlmontanari/scrapli/actions?query=workflow%3A%22Weekly+Build%22)
[](https://codecov.io/gh/carlmontanari/scrapli)
[](https://github.com/ambv/black)
[](https://opensource.org/licenses/MIT)
scrapli
=======
---
**Documentation**: <a href="https://carlmontanari.github.io/scrapli" target="_blank">https://carlmontanari.github.io/scrapli</a>
**Source Code**: <a href="https://github.com/carlmontanari/scrapli" target="_blank">https://github.com/carlmontanari/scrapli</a>
**Examples**: <a href="https://github.com/carlmontanari/scrapli/tree/master/examples" target="_blank">https://github.com/carlmontanari/scrapli/tree/master/examples</a>
---
scrapli -- scrap(e c)li -- is a python 3.7+ library focused on connecting to devices, specifically network devices
(routers/switches/firewalls/etc.) via Telnet or SSH.
#### 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)!
- __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.
- __Sounds great, but I am a Gopher__: For our Go loving friends out there, check out
[scrapligo](https://github.com/scrapli/scrapligo) for a similar experience, but in Go!
## Requirements
MacOS or \*nix<sup>1</sup>, Python 3.7+
scrapli "core" has no requirements other than the Python standard library<sup>2</sup>.
<sup>1</sup> Although many parts of scrapli *do* run on Windows, Windows is not officially supported
<sup>2</sup> While Python 3.6 has been dropped, it *probably* still works, but requires the `dataclass`
backport as well as third party `async_generator` library, Python 3.7+ has no external dependencies for scrapli "core"
## Installation
```
pip install scrapli
```
See the [docs](https://carlmontanari.github.io/scrapli/user_guide/installation) for other installation methods/details.
## A Simple Example
```python
from scrapli import Scrapli
device = {
"host": "172.18.0.11",
"auth_username": "scrapli",
"auth_password": "scrapli",
"auth_strict_key": False,
"platform": "cisco_iosxe"
}
conn = Scrapli(**device)
conn.open()
print(conn.get_prompt())
```
<small>* Bunny artwork by Caroline Montanari, inspired by [@egonelbre](https://github.com/egonelbre/gophers).
The bunny/rabbit is a nod to/inspired by the white rabbit in `Monty Python and the Holy Grail`, because there
are enough snake logos already!</small>
Raw data
{
"_id": null,
"home_page": "",
"name": "scrapli",
"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/77/69/f70f5a9bcd58d9aa0137cf809bdd920c9e3fe00ebd400abdad3edeb7f622/scrapli-2024.1.30.tar.gz",
"platform": null,
"description": "<p center><a href=\"\"><img src=https://github.com/carlmontanari/scrapli/blob/main/scrapli.svg?sanitize=true/></a></p>\n\n[](https://pypi.org/project/scrapli)\n[](https://badge.fury.io/py/scrapli)\n[](https://github.com/carlmontanari/scrapli/actions?query=workflow%3A%22Weekly+Build%22)\n[](https://codecov.io/gh/carlmontanari/scrapli)\n[](https://github.com/ambv/black)\n[](https://opensource.org/licenses/MIT)\n\nscrapli\n=======\n\n---\n\n**Documentation**: <a href=\"https://carlmontanari.github.io/scrapli\" target=\"_blank\">https://carlmontanari.github.io/scrapli</a>\n\n**Source Code**: <a href=\"https://github.com/carlmontanari/scrapli\" target=\"_blank\">https://github.com/carlmontanari/scrapli</a>\n\n**Examples**: <a href=\"https://github.com/carlmontanari/scrapli/tree/master/examples\" target=\"_blank\">https://github.com/carlmontanari/scrapli/tree/master/examples</a>\n\n---\n\nscrapli -- scrap(e c)li -- is a python 3.7+ library focused on connecting to devices, specifically network devices\n (routers/switches/firewalls/etc.) via Telnet or SSH.\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- __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- __Sounds great, but I am a Gopher__: For our Go loving friends out there, check out \n [scrapligo](https://github.com/scrapli/scrapligo) for a similar experience, but in Go!\n\n\n## Requirements\n\nMacOS or \\*nix<sup>1</sup>, Python 3.7+\n\nscrapli \"core\" has no requirements other than the Python standard library<sup>2</sup>.\n\n\n<sup>1</sup> Although many parts of scrapli *do* run on Windows, Windows is not officially supported\n\n<sup>2</sup> While Python 3.6 has been dropped, it *probably* still works, but requires the `dataclass` \nbackport as well as third party `async_generator` library, Python 3.7+ has no external dependencies for scrapli \"core\"\n\n\n## Installation\n\n```\npip install scrapli\n```\n\nSee the [docs](https://carlmontanari.github.io/scrapli/user_guide/installation) for other installation methods/details.\n\n\n\n## A Simple Example\n\n```python\nfrom scrapli import Scrapli\n\ndevice = {\n \"host\": \"172.18.0.11\",\n \"auth_username\": \"scrapli\",\n \"auth_password\": \"scrapli\",\n \"auth_strict_key\": False,\n \"platform\": \"cisco_iosxe\"\n}\n\nconn = Scrapli(**device)\nconn.open()\nprint(conn.get_prompt())\n```\n\n<small>* Bunny artwork by Caroline Montanari, inspired by [@egonelbre](https://github.com/egonelbre/gophers). \nThe bunny/rabbit is a nod to/inspired by the white rabbit in `Monty Python and the Holy Grail`, because there \nare enough snake logos already!</small>\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": "Fast, flexible, sync/async, Python 3.7+ screen scraping client specifically for network devices",
"version": "2024.1.30",
"project_urls": {
"Changelog": "https://carlmontanari.github.io/scrapli/changelog",
"Docs": "https://carlmontanari.github.io/scrapli/",
"Homepage": "https://github.com/carlmontanari/scrapli"
},
"split_keywords": [
"arista",
"automation",
"cisco",
"eos",
"iosxe",
"iosxr",
"juniper",
"junos",
"netconf",
"network",
"nxos",
"ssh",
"telnet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e49a5a9e50098e113986c6e99ab5faf9a11c294b93629cad29993dd530b68d2",
"md5": "56cdfe984eb0d8c4472d1eadc03bf8de",
"sha256": "d1e298bc37ad5894dc8579ac0ea2d033320dcfbb7dbc78e7c6a0614f1e462f0f"
},
"downloads": -1,
"filename": "scrapli-2024.1.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56cdfe984eb0d8c4472d1eadc03bf8de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 143925,
"upload_time": "2024-01-29T02:39:10",
"upload_time_iso_8601": "2024-01-29T02:39:10.170727Z",
"url": "https://files.pythonhosted.org/packages/1e/49/a5a9e50098e113986c6e99ab5faf9a11c294b93629cad29993dd530b68d2/scrapli-2024.1.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7769f70f5a9bcd58d9aa0137cf809bdd920c9e3fe00ebd400abdad3edeb7f622",
"md5": "42096e089cf1dbd47245d8d6bb2658e4",
"sha256": "f9d33e724fae4b1588d2fb6163eb96ce78dd0b5d4ee61097567b93fe536a58f8"
},
"downloads": -1,
"filename": "scrapli-2024.1.30.tar.gz",
"has_sig": false,
"md5_digest": "42096e089cf1dbd47245d8d6bb2658e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 103033,
"upload_time": "2024-01-29T02:39:12",
"upload_time_iso_8601": "2024-01-29T02:39:12.266967Z",
"url": "https://files.pythonhosted.org/packages/77/69/f70f5a9bcd58d9aa0137cf809bdd920c9e3fe00ebd400abdad3edeb7f622/scrapli-2024.1.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 02:39:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "carlmontanari",
"github_project": "scrapli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "scrapli"
}
