| Name | scrapli-cfg JSON |
| Version |
2024.1.30
JSON |
| download |
| home_page | |
| Summary | Network device configuration management with scrapli |
| upload_time | 2024-01-29 02:25:39 |
| 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.
|
[](https://pypi.org/project/scrapli_cfg)
[](https://badge.fury.io/py/scrapli-cfg)
[](https://github.com/scrapli/scrapli_cfg/actions?query=workflow%3A%22Weekly+Build%22)
[](https://github.com/ambv/black)
[](https://opensource.org/licenses/MIT)
scrapli_cfg
===========
---
**Documentation**: <a href="https://scrapli.github.io/scrapli_cfg" target="_blank">https://scrapli.github.io/scrapli_cfg</a>
**Source Code**: <a href="https://github.com/scrapli/scrapli_cfg" target="_blank">https://github.com/scrapli/scrapli_cfg</a>
**Examples**: <a href="https://github.com/scrapli/scrapli_cfg/tree/master/examples" target="_blank">https://github.com/scrapli/scrapli_cfg/tree/master/examples</a>
---
scrapli_cfg makes merging or replacing device configurations over Telnet or SSH easy, all while giving you the
scrapli behaviour you know and love.
#### Key Features:
- __Easy__: It's easy to get going with scrapli and scrapli-cfg -- check out the documentation and example links above,
and you'll be managing device configurations 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! All the "normal"
scrapli transport plugin goodness exists here in scrapli-cfg too!
- __Great Developer Experience__: scrapli_cfg has great editor support thanks to being fully typed; that plus
thorough docs make developing with scrapli a breeze.
## Requirements
MacOS or \*nix<sup>1</sup>, Python 3.7+
scrapli_cfg's only requirements is `scrapli`.
<sup>1</sup> Although many parts of scrapli *do* run on Windows, Windows is not officially supported
## Installation
```
pip install scrapli-cfg
```
See the [docs](https://scrapli.github.io/scrapli_cfg/user_guide/installation) for other installation methods/details.
## A simple Example
```python
from scrapli import Scrapli
from scrapli_cfg import ScrapliCfg
device = {
"host": "172.18.0.11",
"auth_username": "scrapli",
"auth_password": "scrapli",
"auth_strict_key": False,
"platform": "cisco_iosxe"
}
with open("myconfig", "r") as f:
my_config = f.read()
with Scrapli(**device) as conn:
cfg_conn = ScrapliCfg(conn=conn)
cfg_conn.prepare()
cfg_conn.load_config(config=my_config, replace=True)
diff = cfg_conn.diff_config()
print(diff.side_by_side_diff)
cfg_conn.commit_config()
cfg_conn.cleanup()
```
Raw data
{
"_id": null,
"home_page": "",
"name": "scrapli-cfg",
"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/7f/e0/2fbb7465cea0b9f8894d8776d753ee6a86d748b66f47340d201c1e789491/scrapli_cfg-2024.1.30.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/scrapli_cfg)\n[](https://badge.fury.io/py/scrapli-cfg)\n[](https://github.com/scrapli/scrapli_cfg/actions?query=workflow%3A%22Weekly+Build%22)\n[](https://github.com/ambv/black)\n[](https://opensource.org/licenses/MIT)\n\nscrapli_cfg\n===========\n\n---\n\n**Documentation**: <a href=\"https://scrapli.github.io/scrapli_cfg\" target=\"_blank\">https://scrapli.github.io/scrapli_cfg</a>\n\n**Source Code**: <a href=\"https://github.com/scrapli/scrapli_cfg\" target=\"_blank\">https://github.com/scrapli/scrapli_cfg</a>\n\n**Examples**: <a href=\"https://github.com/scrapli/scrapli_cfg/tree/master/examples\" target=\"_blank\">https://github.com/scrapli/scrapli_cfg/tree/master/examples</a>\n\n---\n\nscrapli_cfg makes merging or replacing device configurations over Telnet or SSH easy, all while giving you the \nscrapli behaviour you know and love.\n\n\n#### Key Features:\n\n- __Easy__: It's easy to get going with scrapli and scrapli-cfg -- check out the documentation and example links above, \n and you'll be managing device configurations 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! All the \"normal\" \n scrapli transport plugin goodness exists here in scrapli-cfg too!\n- __Great Developer Experience__: scrapli_cfg has great editor support thanks to being fully typed; that plus \n thorough docs make developing with scrapli a breeze.\n\n\n## Requirements\n\nMacOS or \\*nix<sup>1</sup>, Python 3.7+\n\nscrapli_cfg's only requirements is `scrapli`.\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-cfg\n```\n\nSee the [docs](https://scrapli.github.io/scrapli_cfg/user_guide/installation) for other installation methods/details.\n\n\n\n## A simple Example\n\n```python\nfrom scrapli import Scrapli\nfrom scrapli_cfg import ScrapliCfg\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\nwith open(\"myconfig\", \"r\") as f:\n my_config = f.read()\n\nwith Scrapli(**device) as conn:\n cfg_conn = ScrapliCfg(conn=conn)\n cfg_conn.prepare()\n cfg_conn.load_config(config=my_config, replace=True)\n diff = cfg_conn.diff_config()\n print(diff.side_by_side_diff)\n cfg_conn.commit_config()\n cfg_conn.cleanup()\n\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": "Network device configuration management with scrapli",
"version": "2024.1.30",
"project_urls": {
"Changelog": "https://scrapli.github.io/scrapli_cfg/changelog/",
"Docs": "https://scrapli.github.io/scrapli_cfg/",
"Homepage": "https://github.com/scrapli/scrapli_cfg"
},
"split_keywords": [
"arista",
"automation",
"cisco",
"eos",
"iosxe",
"iosxr",
"juniper",
"junos",
"netconf",
"network",
"nxos",
"ssh",
"telnet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c031fe93c0e4468b214337df100a7f7fcb55ccb6c0beab3e330eb33f9d1961e5",
"md5": "f9d0b3066453598206adc8600bcb5cb4",
"sha256": "74914e284f554d5d7b562eed01f34e5d3be69606dc1c20be97346294b60f9247"
},
"downloads": -1,
"filename": "scrapli_cfg-2024.1.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9d0b3066453598206adc8600bcb5cb4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 60943,
"upload_time": "2024-01-29T02:25:37",
"upload_time_iso_8601": "2024-01-29T02:25:37.755266Z",
"url": "https://files.pythonhosted.org/packages/c0/31/fe93c0e4468b214337df100a7f7fcb55ccb6c0beab3e330eb33f9d1961e5/scrapli_cfg-2024.1.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7fe02fbb7465cea0b9f8894d8776d753ee6a86d748b66f47340d201c1e789491",
"md5": "f241e51d602226caf2e524eb5ed2996b",
"sha256": "67e571d6b4db02f94fdd74c673fbd3ded207be40f8f61905c7a98117424a41b7"
},
"downloads": -1,
"filename": "scrapli_cfg-2024.1.30.tar.gz",
"has_sig": false,
"md5_digest": "f241e51d602226caf2e524eb5ed2996b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 37266,
"upload_time": "2024-01-29T02:25:39",
"upload_time_iso_8601": "2024-01-29T02:25:39.729016Z",
"url": "https://files.pythonhosted.org/packages/7f/e0/2fbb7465cea0b9f8894d8776d753ee6a86d748b66f47340d201c1e789491/scrapli_cfg-2024.1.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-29 02:25:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scrapli",
"github_project": "scrapli_cfg",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "scrapli-cfg"
}
