Metadata-Version: 2.1
Name: scrapli
Version: 2023.7.30
Summary: Fast, flexible, sync/async, Python 3.7+ screen scraping client specifically for network devices
Author-email: Carl Montanari <carl.r.montanari@gmail.com>
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.
        
Project-URL: Changelog, https://carlmontanari.github.io/scrapli/changelog
Project-URL: Docs, https://carlmontanari.github.io/scrapli/
Project-URL: Homepage, https://github.com/carlmontanari/scrapli
Keywords: arista,automation,cisco,eos,iosxe,iosxr,juniper,junos,netconf,network,nxos,ssh,telnet
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: asyncssh
Requires-Dist: asyncssh <3.0.0,>=2.2.1 ; extra == 'asyncssh'
Provides-Extra: community
Requires-Dist: scrapli-community >=2021.01.30 ; extra == 'community'
Provides-Extra: dev
Requires-Dist: asyncssh <3.0.0,>=2.2.1 ; extra == 'dev'
Requires-Dist: black <24.0.0,>=23.3.0 ; extra == 'dev'
Requires-Dist: darglint <2.0.0,>=1.8.1 ; extra == 'dev'
Requires-Dist: isort <6.0.0,>=5.10.1 ; extra == 'dev'
Requires-Dist: mypy ==1.4.1 ; extra == 'dev'
Requires-Dist: nox ==2023.4.22 ; extra == 'dev'
Requires-Dist: ntc-templates <4.0.0,>=1.1.0 ; extra == 'dev'
Requires-Dist: paramiko <3.0.0,>=2.6.0 ; extra == 'dev'
Requires-Dist: pycodestyle <3.0.0,>=2.8.0 ; extra == 'dev'
Requires-Dist: pydocstyle <7.0.0,>=6.1.1 ; extra == 'dev'
Requires-Dist: pyfakefs <6.0.0,>=5.0.0 ; extra == 'dev'
Requires-Dist: pylama <9.0.0,>=8.4.0 ; extra == 'dev'
Requires-Dist: pylint ==2.17.5 ; extra == 'dev'
Requires-Dist: pytest-asyncio <1.0.0,>=0.17.0 ; extra == 'dev'
Requires-Dist: pytest-cov <5.0.0,>=3.0.0 ; extra == 'dev'
Requires-Dist: pytest <8.0.0,>=7.0.0 ; extra == 'dev'
Requires-Dist: scrapli-cfg ==2022.7.30 ; extra == 'dev'
Requires-Dist: scrapli-replay ==2022.7.30 ; extra == 'dev'
Requires-Dist: scrapli-community >=2021.01.30 ; extra == 'dev'
Requires-Dist: textfsm <2.0.0,>=1.1.0 ; extra == 'dev'
Requires-Dist: toml <1.0.0,>=0.10.2 ; extra == 'dev'
Requires-Dist: ttp <1.0.0,>=0.5.0 ; extra == 'dev'
Requires-Dist: types-paramiko <4.0.0,>=2.8.6 ; extra == 'dev'
Requires-Dist: types-pkg-resources <1.0.0,>=0.1.3 ; extra == 'dev'
Requires-Dist: ssh2-python <2.0.0,>=0.23.0 ; (python_version < "3.12") and extra == 'dev'
Requires-Dist: genie >=20.2 ; (sys_platform != "win32" and python_version < "3.11") and extra == 'dev'
Requires-Dist: pyats >=20.2 ; (sys_platform != "win32" and python_version < "3.11") and extra == 'dev'
Provides-Extra: docs
Requires-Dist: mdx-gh-links <1.0,>=0.2 ; extra == 'docs'
Requires-Dist: mkdocs-gen-files <1.0.0,>=0.4.0 ; extra == 'docs'
Requires-Dist: mkdocs-literate-nav <1.0.0,>=0.5.0 ; extra == 'docs'
Requires-Dist: mkdocs-material-extensions <2.0.0,>=1.0.3 ; extra == 'docs'
Requires-Dist: mkdocs-material <10.0.0,>=8.1.6 ; extra == 'docs'
Requires-Dist: mkdocs-section-index <1.0.0,>=0.3.4 ; extra == 'docs'
Requires-Dist: mkdocs <2.0.0,>=1.2.3 ; extra == 'docs'
Requires-Dist: mkdocstrings[python] <1.0.0,>=0.19.0 ; extra == 'docs'
Provides-Extra: genie
Requires-Dist: genie >=20.2 ; (sys_platform != "win32" and python_version < "3.11") and extra == 'genie'
Requires-Dist: pyats >=20.2 ; (sys_platform != "win32" and python_version < "3.11") and extra == 'genie'
Provides-Extra: paramiko
Requires-Dist: paramiko <3.0.0,>=2.6.0 ; extra == 'paramiko'
Provides-Extra: ssh2
Requires-Dist: ssh2-python <2.0.0,>=0.23.0 ; (python_version < "3.12") and extra == 'ssh2'
Provides-Extra: textfsm
Requires-Dist: ntc-templates <4.0.0,>=1.1.0 ; extra == 'textfsm'
Requires-Dist: textfsm <2.0.0,>=1.1.0 ; extra == 'textfsm'
Provides-Extra: ttp
Requires-Dist: ttp <1.0.0,>=0.5.0 ; extra == 'ttp'

<p center><a href=""><img src=https://github.com/carlmontanari/scrapli/blob/main/scrapli.svg?sanitize=true/></a></p>

[![Supported Versions](https://img.shields.io/pypi/pyversions/scrapli.svg)](https://pypi.org/project/scrapli)
[![PyPI version](https://badge.fury.io/py/scrapli.svg)](https://badge.fury.io/py/scrapli)
[![Weekly Build](https://github.com/carlmontanari/scrapli/workflows/Weekly%20Build/badge.svg)](https://github.com/carlmontanari/scrapli/actions?query=workflow%3A%22Weekly+Build%22)
[![Coverage](https://codecov.io/gh/carlmontanari/scrapli/branch/master/graph/badge.svg)](https://codecov.io/gh/carlmontanari/scrapli)
[![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
=======

---

**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>
