| Name | scrapli-netconf JSON |
| Version |
2024.7.30
JSON |
| download |
| home_page | None |
| Summary | Fast, flexible, sync/async, Python 3.7+ NETCONF client built on scrapli |
| upload_time | 2024-07-30 14:33:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| 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.
|
[](https://pypi.org/project/scrapli-netconf)
[](https://badge.fury.io/py/scrapli-netconf)
[](https://github.com/scrapli/scrapli_netconf/actions?query=workflow%3A%22Weekly+Build%22)
[](https://github.com/ambv/black)
[](https://opensource.org/licenses/MIT)
scrapli_netconf
===============
---
**Documentation**: <a href="https://scrapli.github.io/scrapli_netconf" target="_blank">https://scrapli.github.io/scrapli_netconf</a>
**Source Code**: <a href="https://github.com/scrapli/scrapli_netconf" target="_blank">https://github.com/scrapli/scrapli_netconf</a>
**Examples**: <a href="https://github.com/scrapli/scrapli_netconf/tree/master/examples" target="_blank">https://github.com/scrapli/scrapli_netconf/tree/master/examples</a>
---
scrapli_netconf is a NETCONF driver built on top of scrapli, giving you all the scrapli behaviour you know and love,
but for NETCONF connections.
#### Key Features:
- __Easy__: Just like scrapli, scrapli_netconf is easy to get going with, and looks and feels just like "normal"
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! scrapli_netconf supports all of the ssh transports that
scrapli core supports; check out the `ssh2` transport if you've got the need for speed!
- __Great Developer Experience__: scrapli_netconf 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_netconf has lots of tests! Unit tests
cover the basics, regularly ran functional tests connect to virtual routers to ensure that everything works IRL!
- __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+
scrapli_netconf's only requirements are `scrapli`, of course, and `lxml`.
<sup>1</sup> Although many parts of scrapli *do* run on Windows, Windows is not officially supported
## Installation
```
pip install scrapli_netconf
```
See the [docs](https://scrapli.github.io/scrapli_netconf/user_guide/installation) for other installation methods/details.
## A Simple Example
```python
from scrapli_netconf.driver import NetconfDriver
my_device = {
"host": "172.18.0.13",
"auth_username": "scrapli",
"auth_password": "scrapli",
"auth_strict_key": False,
"port": 830
}
conn = NetconfDriver(**my_device)
conn.open()
response = conn.get_config(source="running")
print(response.result)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "scrapli-netconf",
"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/51/df/26f5847cf03dfa229a80a72a100d9dabcd09285cacb016035525ddee2764/scrapli_netconf-2024.7.30.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/scrapli-netconf)\n[](https://badge.fury.io/py/scrapli-netconf)\n[](https://github.com/scrapli/scrapli_netconf/actions?query=workflow%3A%22Weekly+Build%22)\n[](https://github.com/ambv/black)\n[](https://opensource.org/licenses/MIT)\n\nscrapli_netconf\n===============\n\n---\n\n**Documentation**: <a href=\"https://scrapli.github.io/scrapli_netconf\" target=\"_blank\">https://scrapli.github.io/scrapli_netconf</a>\n\n**Source Code**: <a href=\"https://github.com/scrapli/scrapli_netconf\" target=\"_blank\">https://github.com/scrapli/scrapli_netconf</a>\n\n**Examples**: <a href=\"https://github.com/scrapli/scrapli_netconf/tree/master/examples\" target=\"_blank\">https://github.com/scrapli/scrapli_netconf/tree/master/examples</a>\n\n---\n\nscrapli_netconf is a NETCONF driver built on top of scrapli, giving you all the scrapli behaviour you know and love, \nbut for NETCONF connections.\n\n\n#### Key Features:\n\n- __Easy__: Just like scrapli, scrapli_netconf is easy to get going with, and looks and feels just like \"normal\" \n scrapli -- check out the documentation and example links above, and you'll be connecting to devices in no time.\n- __Fast__: Do you like to go fast? Of course you do! scrapli_netconf supports all of the ssh transports that \n scrapli core supports; check out the `ssh2` transport if you've got the need for speed!\n- __Great Developer Experience__: scrapli_netconf has great editor support thanks to being fully typed; that plus \n thorough docs make developing with scrapli a breeze.\n- __Well Tested__: Perhaps out of paranoia, but regardless of the reason, scrapli_netconf 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- __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\nscrapli_netconf's only requirements are `scrapli`, of course, and `lxml`.\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_netconf\n```\n\nSee the [docs](https://scrapli.github.io/scrapli_netconf/user_guide/installation) for other installation methods/details.\n\n\n\n## A Simple Example\n\n```python\nfrom scrapli_netconf.driver import NetconfDriver\n\nmy_device = {\n \"host\": \"172.18.0.13\",\n \"auth_username\": \"scrapli\",\n \"auth_password\": \"scrapli\",\n \"auth_strict_key\": False,\n \"port\": 830\n}\n\nconn = NetconfDriver(**my_device)\nconn.open()\nresponse = conn.get_config(source=\"running\")\nprint(response.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": "Fast, flexible, sync/async, Python 3.7+ NETCONF client built on scrapli",
"version": "2024.7.30",
"project_urls": {
"Changelog": "https://scrapli.github.io/scrapli_netconf/changelog/",
"Docs": "https://scrapli.github.io/scrapli_netconf/",
"Homepage": "https://github.com/scrapli/scrapli_netconf"
},
"split_keywords": [
"arista",
" automation",
" cisco",
" eos",
" iosxe",
" iosxr",
" juniper",
" junos",
" netconf",
" network",
" nxos",
" ssh",
" telnet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72c9e3c21531f171002073f1e4f51c7e25976bd3b8a69e75ff934235767d43c5",
"md5": "9944d3749a45a37a37b36bb9ee2a09dc",
"sha256": "e6de8ef905ca4c9365f8c16463db04280235ba68f0baa8ae852a109333e70029"
},
"downloads": -1,
"filename": "scrapli_netconf-2024.7.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9944d3749a45a37a37b36bb9ee2a09dc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 37113,
"upload_time": "2024-07-30T14:33:24",
"upload_time_iso_8601": "2024-07-30T14:33:24.735164Z",
"url": "https://files.pythonhosted.org/packages/72/c9/e3c21531f171002073f1e4f51c7e25976bd3b8a69e75ff934235767d43c5/scrapli_netconf-2024.7.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51df26f5847cf03dfa229a80a72a100d9dabcd09285cacb016035525ddee2764",
"md5": "eb8c7e85ff2b57a8b1f7e23894c249c8",
"sha256": "9ae9a440ed1cefff56f1d7550d8964c5e225f430b3db70ac3197c9b5633bf100"
},
"downloads": -1,
"filename": "scrapli_netconf-2024.7.30.tar.gz",
"has_sig": false,
"md5_digest": "eb8c7e85ff2b57a8b1f7e23894c249c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 30494,
"upload_time": "2024-07-30T14:33:26",
"upload_time_iso_8601": "2024-07-30T14:33:26.394564Z",
"url": "https://files.pythonhosted.org/packages/51/df/26f5847cf03dfa229a80a72a100d9dabcd09285cacb016035525ddee2764/scrapli_netconf-2024.7.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 14:33:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scrapli",
"github_project": "scrapli_netconf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "scrapli-netconf"
}
