| Name | scrapli-replay JSON |
| Version |
2024.7.30
JSON |
| download |
| home_page | None |
| Summary | Tools to enable easy testing of scrapli programs |
| upload_time | 2024-07-30 14:34:19 |
| 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 |
asyncssh
ruamel.yaml
scrapli
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/scrapli-replay)
[](https://badge.fury.io/py/scrapli-replay)
[](https://github.com/scrapli/scrapli_replay/workflows/Weekly%20Build)
[](https://github.com/ambv/black)
[](https://opensource.org/licenses/MIT)
scrapli_replay
==============
---
**Documentation**: <a href="https://scrapli.github.io/scrapli_replay" target="_blank">https://scrapli.github.io/scrapli_replay</a>
**Source Code**: <a href="https://github.com/scrapli/scrapli_replay" target="_blank">https://github.com/scrapli/scrapli_replay</a>
**Examples**: <a href="https://github.com/scrapli/scrapli_replay/tree/main/examples/simple_test_case" target="_blank">https://github.com/scrapli/scrapli_replay/tree/main/examples/simple_test_case</a>
---
scrapli_replay: Tools to enable easy testing of scrapli programs and to create semi-interactive SSH servers that
look and feel like "real" network devices!
#### Key Features:
- __Easy__: Easily test scrapli code with Pytest, or create mock SSH servers to play with!
- __Pytest__: Love scrapli and Pytest? Want to test your code that contains scrapli components, but can't test
against real devices in your CI? scrapli_replay is a Pytest plugin to help you with exactly this -- its like
[VCR.py](https://vcrpy.readthedocs.io/en/latest/) and [pytest-vcr](http://pytest-vcr.readthedocs.io/en/latest/), but for scrapli!
- __Offline__: Want to be able to have the look and feel of a network device without having a network device? Create
a mock SSH server based on real network device behavior and run it in your CI or a Raspberry Pi (or whatever)!
- __Lightweight__: Want to spin up a bunch of test servers, but don't have the resources for real device images?
Asyncssh is fast and lightweight so you can run loads of mock SSH servers with very little resources!
## Installation
```
pip install scrapli_replay
```
See the [docs](https://scrapli.github.io/scrapli_replay/user_guide/installation) for other installation methods/details.
## A Simple (Pytest) Example
```python
@pytest.mark.scrapli_replay
def test_something_else():
with IOSXEDriver(**MY_DEVICE) as conn:
result = conn.send_command("show run | i hostname")
```
Raw data
{
"_id": null,
"home_page": null,
"name": "scrapli-replay",
"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/f5/88/088555d521e590a08c739a476693c50ba7f53419867d61c88f88cb8940f2/scrapli_replay-2024.7.30.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/scrapli-replay)\n[](https://badge.fury.io/py/scrapli-replay)\n[](https://github.com/scrapli/scrapli_replay/workflows/Weekly%20Build)\n[](https://github.com/ambv/black)\n[](https://opensource.org/licenses/MIT)\n\nscrapli_replay\n==============\n\n---\n\n**Documentation**: <a href=\"https://scrapli.github.io/scrapli_replay\" target=\"_blank\">https://scrapli.github.io/scrapli_replay</a>\n\n**Source Code**: <a href=\"https://github.com/scrapli/scrapli_replay\" target=\"_blank\">https://github.com/scrapli/scrapli_replay</a>\n\n**Examples**: <a href=\"https://github.com/scrapli/scrapli_replay/tree/main/examples/simple_test_case\" target=\"_blank\">https://github.com/scrapli/scrapli_replay/tree/main/examples/simple_test_case</a>\n\n---\n\nscrapli_replay: Tools to enable easy testing of scrapli programs and to create semi-interactive SSH servers that \nlook and feel like \"real\" network devices!\n\n\n#### Key Features:\n\n- __Easy__: Easily test scrapli code with Pytest, or create mock SSH servers to play with!\n- __Pytest__: Love scrapli and Pytest? Want to test your code that contains scrapli components, but can't test \n against real devices in your CI? scrapli_replay is a Pytest plugin to help you with exactly this -- its like \n [VCR.py](https://vcrpy.readthedocs.io/en/latest/) and [pytest-vcr](http://pytest-vcr.readthedocs.io/en/latest/), but for scrapli!\n- __Offline__: Want to be able to have the look and feel of a network device without having a network device? Create \n a mock SSH server based on real network device behavior and run it in your CI or a Raspberry Pi (or whatever)!\n- __Lightweight__: Want to spin up a bunch of test servers, but don't have the resources for real device images? \n Asyncssh is fast and lightweight so you can run loads of mock SSH servers with very little resources!\n\n\n## Installation\n\n```\npip install scrapli_replay\n```\n\nSee the [docs](https://scrapli.github.io/scrapli_replay/user_guide/installation) for other installation methods/details.\n\n\n\n## A Simple (Pytest) Example\n\n```python\n@pytest.mark.scrapli_replay\ndef test_something_else():\n with IOSXEDriver(**MY_DEVICE) as conn:\n result = conn.send_command(\"show run | i hostname\")\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": "Tools to enable easy testing of scrapli programs",
"version": "2024.7.30",
"project_urls": {
"Changelog": "https://scrapli.github.io/scrapli_replay/changelog/",
"Docs": "https://scrapli.github.io/scrapli_replay/",
"Homepage": "https://github.com/scrapli/scrapli_replay"
},
"split_keywords": [
"arista",
" automation",
" cisco",
" eos",
" iosxe",
" iosxr",
" juniper",
" junos",
" netconf",
" network",
" nxos",
" ssh",
" telnet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b60669a081127725dbb16bf2d286eb27870c2942a2d1feefd29438e7e9beee2",
"md5": "90e26aa9b8cf65a649b1c532adcc169e",
"sha256": "e703cbb0cd846bfcaab494679d78a48066a1a2d3ef7a6aa46de589824d752ad0"
},
"downloads": -1,
"filename": "scrapli_replay-2024.7.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90e26aa9b8cf65a649b1c532adcc169e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27052,
"upload_time": "2024-07-30T14:34:17",
"upload_time_iso_8601": "2024-07-30T14:34:17.281116Z",
"url": "https://files.pythonhosted.org/packages/9b/60/669a081127725dbb16bf2d286eb27870c2942a2d1feefd29438e7e9beee2/scrapli_replay-2024.7.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f588088555d521e590a08c739a476693c50ba7f53419867d61c88f88cb8940f2",
"md5": "8f4de292fc707964f3f1967fb2985d4b",
"sha256": "4ec3e5facf161b69d383e5680b87cf66b8a6c79079e4d077b6237e0011127b03"
},
"downloads": -1,
"filename": "scrapli_replay-2024.7.30.tar.gz",
"has_sig": false,
"md5_digest": "8f4de292fc707964f3f1967fb2985d4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27320,
"upload_time": "2024-07-30T14:34:19",
"upload_time_iso_8601": "2024-07-30T14:34:19.151179Z",
"url": "https://files.pythonhosted.org/packages/f5/88/088555d521e590a08c739a476693c50ba7f53419867d61c88f88cb8940f2/scrapli_replay-2024.7.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-30 14:34:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scrapli",
"github_project": "scrapli_replay",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "asyncssh",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"2.2.1"
]
]
},
{
"name": "ruamel.yaml",
"specs": [
[
">=",
"0.17"
],
[
"<",
"0.18"
]
]
},
{
"name": "scrapli",
"specs": [
[
">=",
"2021.07.30"
]
]
}
],
"lcname": "scrapli-replay"
}
