simnos 2.0.0__tar.gz

simnos-2.0.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.3
+Name: simnos
+Version: 2.0.0
+Summary: Simulated Network Operating System
+Keywords: NetworkAutomation,Testing,SSH,Integration,NOS
+Author: KeroRoute lab
+License: MIT
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: paramiko>=4.0,<5.0
+Requires-Dist: pyyaml<7.0
+Requires-Dist: pydantic<3.0
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: detect==2020.12.*
+Maintainer: KeroRoute lab
+Requires-Python: >=3.13, <3.15
+Project-URL: Documentation, https://route-reflector.github.io/simnos/
+Project-URL: Homepage, https://github.com/Route-Reflector/simnos/
+Description-Content-Type: text/markdown
+
+[English](README.md) | [日本語](README.ja.md)
+
+[![Downloads][pepy-downloads-badge]][pepy-downloads-link]
+[![PyPI][pypi-latest-release-badge]][pypi-latest-release-link]
+[![PyPI versions][pypi-pyversion-badge]][pypi-pyversion-link]
+[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
+[![Ruff][ruff-badge]][ruff-link]
+[![Tests][github-tests-badge]][github-tests-link]
+
+# Simulated Network Operating Systems - SIMNOS
+
+> "Reality is merely an illusion, albeit a very persistent one."
+>
+> ~ Albert Einstein
+
+SIMNOS simulates Network Operating Systems interactions. You can simulate
+network devices like Cisco IOS or Huawei SmartAX interactions over
+SSH with little effort. This project is mainly intended for testing
+and development purposes.
+
+[Documentation](https://route-reflector.github.io/simnos/) | [Examples](https://route-reflector.github.io/simnos/examples/) | [Platforms](https://route-reflector.github.io/simnos/platforms/)
+
+## Origin
+
+SIMNOS is an independent project derived from [FakeNOS](https://github.com/fakenos/fakenos), created by Denis Mulyalin and maintained by Enric Perpinyà Pitarch. After significant divergence in tooling, platforms, and architecture, it was rebranded as SIMNOS to avoid confusion with the upstream project.
+
+**AI Transparency:** AI-assisted development (Claude Code, Codex, Gemini, etc.) is actively used in this project. All AI-generated changes are reviewed by a human maintainer before merging.
+
+**Key differences from FakeNOS:**
+
+- Package name: `simnos` (on PyPI)
+- Package manager: uv (migrated from Poetry)
+- Linter/Formatter: Ruff (migrated from Black/Pylint)
+- Python support: 3.13 / 3.14
+- CI: Modernized GitHub Actions workflow
+- NOS platforms: 5 additional platforms enabled (brocade_fastiron, ciena_saos, fortinet, juniper_screenos, ruckus_fastiron)
+- Paramiko: upgraded to 4.0 with DH Group Exchange server-mode workaround
+
+## Why?
+
+Crucial aspect of writing applications or scripts for Network Automation is
+testing, often testing done using physical or virtual instances of network
+appliances running certain version of Network Operating System (NOS). That
+approach, while gives best integration results, in many cases carries a lot
+of overhead to setup, run and tear down as well as putting significant burden
+on compute and storage resource utilization.
+
+Other approach is to mock underlying libraries methods to fool applications
+under testing into believing that it is getting output from real devices. That
+approach works very well for unit testing, but fails to simulate such aspects
+as connection establishment and handling.
+
+SIMNOS positions itself somewhere in the middle between full integration testing
+and testing that mocks device interactions. SIMNOS allows to create NOS plugins
+to produce pre-defined output to test applications behavior while running servers
+to establish connections with.
+
+## What?
+
+SIMNOS can:
+
+- Run thousands of servers to stress test applications
+- Simulate Network Operating Systems Command Line Interface (CLI) interactions
+- Provide high-level API to create custom NOS plugins
+- Run in docker container to simplify integration with your infrastructure
+- Make use of SIMNOS CLI tool for quick run and prototype simulations
+- Works on Windows, Mac and Linux under Python 3.13 and 3.14
+
+## How?
+
+Send input and get the output - this is how we interact with many
+Network Operating Systems, SIMNOS allows to pre-define the output
+to sent in response to certain input commands, making it ideal for
+isolated feature testing.
+
+SIMNOS is a micro-kernel framework that can be extended using plugins.
+The core is kept small and optimized while most of the functionality
+offloaded to plugins.
+
+SIMNOS has these pluggable systems:
+
+- Server Plugins - plugins responsible for running various servers to connect with
+- Shell Plugins - plugins to simulate command line interface shell
+- NOS plugins - plugins to simulate Network Operating System commands
+
+## What not?
+
+SIMNOS is a simulator, it does not emulate any of Network Control, Data
+or Management planes, it merely takes the commands as input and responds
+with predefined output.
+
+## Acknowledgments
+
+SIMNOS is built upon the work of [FakeNOS](https://github.com/fakenos/fakenos). We are grateful to the original creators and contributors:
+
+- [Denis Mulyalin](https://github.com/dmulyalin) - Original Creator of FakeNOS
+- [Enric Perpinyà Pitarch](https://github.com/evilmonkey19) - Main Collaborator and Maintainer of FakeNOS
+
+### Inspired by and borrowed from
+
+- [sshim](https://pythonhosted.org/sshim/) - library for testing and debugging SSH automation clients
+- [PythonSSHServerTutorial](https://github.com/ramonmeza/PythonSSHServerTutorial) - tutorial on creating paramiko based SSH server
+- [fake-switches](https://github.com/internap/fake-switches) - pluggable switch/router command-line simulator
+- [ncs-netsim](https://developer.cisco.com/docs/nso/guides/#!the-network-simulator) - tool to simulate a network of devices
+- [cisshgo](https://github.com/tbotnz/cisshgo) - concurrent SSH server to emulate network equipment for testing purposes
+- [scrapli-replay](https://pypi.org/project/scrapli-replay/) - tools to enable easy testing of SSH programs and to create semi-interactive SSH servers
+
+[github-discussions-link]:     https://github.com/Route-Reflector/simnos/discussions
+[github-discussions-badge]:    https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[ruff-badge]:                  https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[ruff-link]:                   https://github.com/astral-sh/ruff
+[pypi-pyversion-link]:         https://pypi.python.org/pypi/simnos/
+[pypi-pyversion-badge]:        https://img.shields.io/pypi/pyversions/simnos.svg?logo=python
+[pepy-downloads-link]:         https://pepy.tech/project/simnos
+[pepy-downloads-badge]:        https://pepy.tech/badge/simnos
+[github-tests-badge]:          https://github.com/Route-Reflector/simnos/actions/workflows/main.yml/badge.svg
+[github-tests-link]:           https://github.com/Route-Reflector/simnos/actions
+[pypi-latest-release-link]:    https://pypi.python.org/pypi/simnos
+[pypi-latest-release-badge]:   https://img.shields.io/pypi/v/simnos.svg?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyBpZD0iTGF5ZXJfMiIgZGF0YS1uYW1lPSJMYXllciAyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA2NC41OSA2NC41OCI+CiAgPGRlZnM+CiAgICA8c3R5bGU+CiAgICAgIC5jbHMtMSB7CiAgICAgICAgZmlsbDogIzQwMmE1OTsKICAgICAgfQoKICAgICAgLmNscy0xLCAuY2xzLTIgewogICAgICAgIHN0cm9rZS13aWR0aDogMHB4OwogICAgICB9CgogICAgICAuY2xzLTIgewogICAgICAgIGZpbGw6ICNmZmY7CiAgICAgIH0KICAgIDwvc3R5bGU+CiAgPC9kZWZzPgogIDxnIGlkPSJMYXllcl8xLTIiIGRhdGEtbmFtZT0iTGF5ZXIgMSI+CiAgICA8Zz4KICAgICAgPHBhdGggY2xhc3M9ImNscy0xIiBkPSJNOS42NywwaDQ1LjVjNS4xNS44LDguNTUsMy44NCw5LjQyLDkuMDR2NDYuNjJjLS42OCw0Ljc0LTQuNTQsOC4xNy05LjIzLDguNjctNy40Ni43OS0zNS0uNjYtNDUuMzIsMC00LjQxLjAxLTkuMTUtMy4xMy05Ljc5LTcuNzRDLS4wOCw1NC4xOS0uMDksMTAuMzQuMjUsNy45My44NSwzLjY3LDUuNTMuMjUsOS42NywwWiIvPgogICAgICA8Zz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xMC4yMyw1Ljc4YzIuMTgtLjMxLDQxLjgzLS4zLDQ0LjAxLDAsMi4xNi4zLDMuOTUsMS43Myw0LjU3LDMuODItLjQyLDcuNjIuNTUsNDIuMDEsMCw0NS4zMi0uMzEsMS44Ni0yLjEsMy4xOC0zLjgyLDMuNjQtOC40OC0uNTctNDAuNDIuODctNDQuOTQuMTktMS45My0uMjktMy44OC0yLjA2LTQuMi00LjAxLS4zNi0yLjIxLS4zNi00Mi41NSwwLTQ0Ljc2LjM0LTIuMDksMi4yOC0zLjksNC4zOC00LjJaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0xIiBkPSJNNDkuNTgsMTkuMDJjMTIuOTksMTYuNzEtMy4yMywzOS44My0yMy41LDM0LjMxLTEuMjMtLjMzLTcuMS0zLjAzLTYuOTktNC4wMWwzLjgyLTQuMmMxMi40MSw4LjgzLDI4LjQ3LTMuMzksMjQuNzEtMTcuMjUtMS40My01LjI3LTQuNS0yLjYyLDEuOTYtOC44NloiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTEiIGQ9Ik00MS40NywxOS41OGMtMTQuMzgtOS42Ni0zMS40OCw2LjczLTIyLjU2LDIxLjI2LS4wNSwxLjMtMi45NSwzLjM5LTMuODIsNC42NkMtLjM4LDI1LjIyLDI0Ljg3LjQyLDQ1LjM4LDE1LjAxYy4wNy4zMy0zLjM2LDQuMTgtMy45Miw0LjU3WiIvPgogICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtMiIgZD0iTTQxLjQ3LDE5LjU4Yy0xLjUzLDEuMDctMy0uNjMtNC45NC0xLjEyLTYuNDItMS42MS0xMy4zNi44OS0xNi44OCw2LjYyLTEsMS42Mi0xLjUyLDMuNDgtMi4yNCw1LjIyLS4wOC4yLS40Mi0uMzEtLjU2LDAtLjcsMS41NS4xOSw1LjkzLjc1LDcuNjUuMzcsMS4xNCwxLjM1LDEuNjgsMS4zMSwyLjg5LTguOTItMTQuNTMsOC4xOS0zMC45MSwyMi41Ni0yMS4yNloiLz4KICAgICAgICA8Zz4KICAgICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtMSIgZD0iTTM0LjQ3LDI0LjYyYzMuNTEtLjI0LDUuNzUsMyw0LjU3LDYuMjUtLjM3LDEuMDMtNi4wMSw3LjA4LTYuOTksNy43NC00LjM5LDIuOTMtOC4wMi0uNjQtNi44MS00Ljk0LjI3LS45Niw2LjU3LTguODYsOS4yMy05LjA0WiIvPgogICAgICAgICAgPHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMzUuMjIsMjUuOTJjMS43Ni4wNywyLjkzLDIuMDEsMi43LDMuNjQtLjExLjgxLTguOTUsMTMuNTktMTEuNTYsNi41My0uNzUtMi40OSw2LjkzLTEwLjI0LDguODYtMTAuMTZaIi8+CiAgICAgICAgPC9nPgogICAgICA8L2c+CiAgICA8L2c+CiAgPC9nPgo8L3N2Zz4=

simnos-2.0.0/README.md

@@ -0,0 +1,119 @@
+[English](README.md) | [日本語](README.ja.md)
+
+[![Downloads][pepy-downloads-badge]][pepy-downloads-link]
+[![PyPI][pypi-latest-release-badge]][pypi-latest-release-link]
+[![PyPI versions][pypi-pyversion-badge]][pypi-pyversion-link]
+[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
+[![Ruff][ruff-badge]][ruff-link]
+[![Tests][github-tests-badge]][github-tests-link]
+
+# Simulated Network Operating Systems - SIMNOS
+
+> "Reality is merely an illusion, albeit a very persistent one."
+>
+> ~ Albert Einstein
+
+SIMNOS simulates Network Operating Systems interactions. You can simulate
+network devices like Cisco IOS or Huawei SmartAX interactions over
+SSH with little effort. This project is mainly intended for testing
+and development purposes.
+
+[Documentation](https://route-reflector.github.io/simnos/) | [Examples](https://route-reflector.github.io/simnos/examples/) | [Platforms](https://route-reflector.github.io/simnos/platforms/)
+
+## Origin
+
+SIMNOS is an independent project derived from [FakeNOS](https://github.com/fakenos/fakenos), created by Denis Mulyalin and maintained by Enric Perpinyà Pitarch. After significant divergence in tooling, platforms, and architecture, it was rebranded as SIMNOS to avoid confusion with the upstream project.
+
+**AI Transparency:** AI-assisted development (Claude Code, Codex, Gemini, etc.) is actively used in this project. All AI-generated changes are reviewed by a human maintainer before merging.
+
+**Key differences from FakeNOS:**
+
+- Package name: `simnos` (on PyPI)
+- Package manager: uv (migrated from Poetry)
+- Linter/Formatter: Ruff (migrated from Black/Pylint)
+- Python support: 3.13 / 3.14
+- CI: Modernized GitHub Actions workflow
+- NOS platforms: 5 additional platforms enabled (brocade_fastiron, ciena_saos, fortinet, juniper_screenos, ruckus_fastiron)
+- Paramiko: upgraded to 4.0 with DH Group Exchange server-mode workaround
+
+## Why?
+
+Crucial aspect of writing applications or scripts for Network Automation is
+testing, often testing done using physical or virtual instances of network
+appliances running certain version of Network Operating System (NOS). That
+approach, while gives best integration results, in many cases carries a lot
+of overhead to setup, run and tear down as well as putting significant burden
+on compute and storage resource utilization.
+
+Other approach is to mock underlying libraries methods to fool applications
+under testing into believing that it is getting output from real devices. That
+approach works very well for unit testing, but fails to simulate such aspects
+as connection establishment and handling.
+
+SIMNOS positions itself somewhere in the middle between full integration testing
+and testing that mocks device interactions. SIMNOS allows to create NOS plugins
+to produce pre-defined output to test applications behavior while running servers
+to establish connections with.
+
+## What?
+
+SIMNOS can:
+
+- Run thousands of servers to stress test applications
+- Simulate Network Operating Systems Command Line Interface (CLI) interactions
+- Provide high-level API to create custom NOS plugins
+- Run in docker container to simplify integration with your infrastructure
+- Make use of SIMNOS CLI tool for quick run and prototype simulations
+- Works on Windows, Mac and Linux under Python 3.13 and 3.14
+
+## How?
+
+Send input and get the output - this is how we interact with many
+Network Operating Systems, SIMNOS allows to pre-define the output
+to sent in response to certain input commands, making it ideal for
+isolated feature testing.
+
+SIMNOS is a micro-kernel framework that can be extended using plugins.
+The core is kept small and optimized while most of the functionality
+offloaded to plugins.
+
+SIMNOS has these pluggable systems:
+
+- Server Plugins - plugins responsible for running various servers to connect with
+- Shell Plugins - plugins to simulate command line interface shell
+- NOS plugins - plugins to simulate Network Operating System commands
+
+## What not?
+
+SIMNOS is a simulator, it does not emulate any of Network Control, Data
+or Management planes, it merely takes the commands as input and responds
+with predefined output.
+
+## Acknowledgments
+
+SIMNOS is built upon the work of [FakeNOS](https://github.com/fakenos/fakenos). We are grateful to the original creators and contributors:
+
+- [Denis Mulyalin](https://github.com/dmulyalin) - Original Creator of FakeNOS
+- [Enric Perpinyà Pitarch](https://github.com/evilmonkey19) - Main Collaborator and Maintainer of FakeNOS
+
+### Inspired by and borrowed from
+
+- [sshim](https://pythonhosted.org/sshim/) - library for testing and debugging SSH automation clients
+- [PythonSSHServerTutorial](https://github.com/ramonmeza/PythonSSHServerTutorial) - tutorial on creating paramiko based SSH server
+- [fake-switches](https://github.com/internap/fake-switches) - pluggable switch/router command-line simulator
+- [ncs-netsim](https://developer.cisco.com/docs/nso/guides/#!the-network-simulator) - tool to simulate a network of devices
+- [cisshgo](https://github.com/tbotnz/cisshgo) - concurrent SSH server to emulate network equipment for testing purposes
+- [scrapli-replay](https://pypi.org/project/scrapli-replay/) - tools to enable easy testing of SSH programs and to create semi-interactive SSH servers
+
+[github-discussions-link]:     https://github.com/Route-Reflector/simnos/discussions
+[github-discussions-badge]:    https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[ruff-badge]:                  https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[ruff-link]:                   https://github.com/astral-sh/ruff
+[pypi-pyversion-link]:         https://pypi.python.org/pypi/simnos/
+[pypi-pyversion-badge]:        https://img.shields.io/pypi/pyversions/simnos.svg?logo=python
+[pepy-downloads-link]:         https://pepy.tech/project/simnos
+[pepy-downloads-badge]:        https://pepy.tech/badge/simnos
+[github-tests-badge]:          https://github.com/Route-Reflector/simnos/actions/workflows/main.yml/badge.svg
+[github-tests-link]:           https://github.com/Route-Reflector/simnos/actions
+[pypi-latest-release-link]:    https://pypi.python.org/pypi/simnos
+[pypi-latest-release-badge]:   https://img.shields.io/pypi/v/simnos.svg?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyBpZD0iTGF5ZXJfMiIgZGF0YS1uYW1lPSJMYXllciAyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA2NC41OSA2NC41OCI+CiAgPGRlZnM+CiAgICA8c3R5bGU+CiAgICAgIC5jbHMtMSB7CiAgICAgICAgZmlsbDogIzQwMmE1OTsKICAgICAgfQoKICAgICAgLmNscy0xLCAuY2xzLTIgewogICAgICAgIHN0cm9rZS13aWR0aDogMHB4OwogICAgICB9CgogICAgICAuY2xzLTIgewogICAgICAgIGZpbGw6ICNmZmY7CiAgICAgIH0KICAgIDwvc3R5bGU+CiAgPC9kZWZzPgogIDxnIGlkPSJMYXllcl8xLTIiIGRhdGEtbmFtZT0iTGF5ZXIgMSI+CiAgICA8Zz4KICAgICAgPHBhdGggY2xhc3M9ImNscy0xIiBkPSJNOS42NywwaDQ1LjVjNS4xNS44LDguNTUsMy44NCw5LjQyLDkuMDR2NDYuNjJjLS42OCw0Ljc0LTQuNTQsOC4xNy05LjIzLDguNjctNy40Ni43OS0zNS0uNjYtNDUuMzIsMC00LjQxLjAxLTkuMTUtMy4xMy05Ljc5LTcuNzRDLS4wOCw1NC4xOS0uMDksMTAuMzQuMjUsNy45My44NSwzLjY3LDUuNTMuMjUsOS42NywwWiIvPgogICAgICA8Zz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTIiIGQ9Ik0xMC4yMyw1Ljc4YzIuMTgtLjMxLDQxLjgzLS4zLDQ0LjAxLDAsMi4xNi4zLDMuOTUsMS43Myw0LjU3LDMuODItLjQyLDcuNjIuNTUsNDIuMDEsMCw0NS4zMi0uMzEsMS44Ni0yLjEsMy4xOC0zLjgyLDMuNjQtOC40OC0uNTctNDAuNDIuODctNDQuOTQuMTktMS45My0uMjktMy44OC0yLjA2LTQuMi00LjAxLS4zNi0yLjIxLS4zNi00Mi41NSwwLTQ0Ljc2LjM0LTIuMDksMi4yOC0zLjksNC4zOC00LjJaIi8+CiAgICAgICAgPHBhdGggY2xhc3M9ImNscy0xIiBkPSJNNDkuNTgsMTkuMDJjMTIuOTksMTYuNzEtMy4yMywzOS44My0yMy41LDM0LjMxLTEuMjMtLjMzLTcuMS0zLjAzLTYuOTktNC4wMWwzLjgyLTQuMmMxMi40MSw4LjgzLDI4LjQ3LTMuMzksMjQuNzEtMTcuMjUtMS40My01LjI3LTQuNS0yLjYyLDEuOTYtOC44NloiLz4KICAgICAgICA8cGF0aCBjbGFzcz0iY2xzLTEiIGQ9Ik00MS40NywxOS41OGMtMTQuMzgtOS42Ni0zMS40OCw2LjczLTIyLjU2LDIxLjI2LS4wNSwxLjMtMi45NSwzLjM5LTMuODIsNC42NkMtLjM4LDI1LjIyLDI0Ljg3LjQyLDQ1LjM4LDE1LjAxYy4wNy4zMy0zLjM2LDQuMTgtMy45Miw0LjU3WiIvPgogICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtMiIgZD0iTTQxLjQ3LDE5LjU4Yy0xLjUzLDEuMDctMy0uNjMtNC45NC0xLjEyLTYuNDItMS42MS0xMy4zNi44OS0xNi44OCw2LjYyLTEsMS42Mi0xLjUyLDMuNDgtMi4yNCw1LjIyLS4wOC4yLS40Mi0uMzEtLjU2LDAtLjcsMS41NS4xOSw1LjkzLjc1LDcuNjUuMzcsMS4xNCwxLjM1LDEuNjgsMS4zMSwyLjg5LTguOTItMTQuNTMsOC4xOS0zMC45MSwyMi41Ni0yMS4yNloiLz4KICAgICAgICA8Zz4KICAgICAgICAgIDxwYXRoIGNsYXNzPSJjbHMtMSIgZD0iTTM0LjQ3LDI0LjYyYzMuNTEtLjI0LDUuNzUsMyw0LjU3LDYuMjUtLjM3LDEuMDMtNi4wMSw3LjA4LTYuOTksNy43NC00LjM5LDIuOTMtOC4wMi0uNjQtNi44MS00Ljk0LjI3LS45Niw2LjU3LTguODYsOS4yMy05LjA0WiIvPgogICAgICAgICAgPHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMzUuMjIsMjUuOTJjMS43Ni4wNywyLjkzLDIuMDEsMi43LDMuNjQtLjExLjgxLTguOTUsMTMuNTktMTEuNTYsNi41My0uNzUtMi40OSw2LjkzLTEwLjI0LDguODYtMTAuMTZaIi8+CiAgICAgICAgPC9nPgogICAgICA8L2c+CiAgICA8L2c+CiAgPC9nPgo8L3N2Zz4=

simnos-2.0.0/pyproject.toml

@@ -0,0 +1,152 @@
+[project]
+name = "simnos"
+version = "2.0.0"
+description = "Simulated Network Operating System"
+authors = [
+    { name = "KeroRoute lab" },
+]
+maintainers = [
+    { name = "KeroRoute lab" },
+]
+license = { text = "MIT" }
+readme = "README.md"
+keywords = [
+    "NetworkAutomation",
+    "Testing",
+    "SSH",
+    "Integration",
+    "NOS"
+]
+classifiers = [
+    "Intended Audience :: Telecommunications Industry",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Unix",
+    "Operating System :: MacOS",
+    "Topic :: Utilities",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "License :: OSI Approved :: MIT License",
+]
+requires-python = ">=3.13,<3.15"
+dependencies = [
+    "paramiko>=4.0,<5.0",
+    "pyyaml<7.0",
+    "pydantic<3.0",
+    "jinja2>=3.1.6",
+    "detect==2020.12.*",
+]
+
+
+[project.urls]
+Homepage = "https://github.com/Route-Reflector/simnos/"
+Documentation = "https://route-reflector.github.io/simnos/"
+
+[project.scripts]
+simnos = "simnos.plugins.utils.cli:run_cli"
+
+[tool.ruff]
+line-length = 120
+target-version = "py313"
+exclude = ["venv", ".venv", "env", ".env"]
+
+[tool.ruff.lint]
+select = [
+    "B",     # flake8-bugbear
+    "C4",    # flake8-comprehensions
+    "E",     # pycodestyle
+    "F",     # pyflakes
+    "I",     # isort
+    "PERF",  # Perflint
+    "RUF",   # ruff itself
+    "S",     # flake8-bandit
+    "SIM",   # flake8-simplify
+    "UP",    # pyupgrade
+    "W",     # pycodestyle
+]
+ignore = [
+    "RUF001",  # ambiguous-unicode-character-string
+    "RUF002",  # ambiguous-unicode-character-docstring
+    "RUF003",  # ambiguous-unicode-character-comment
+    "RUF012",  # mutable-class-default
+    "SIM108",  # if-else-block-instead-of-if-exp
+]
+dummy-variable-rgx = "^_.*"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "S101",  # Allow use of assert in tests
+    "S311",  # Allow use of random in tests
+    "S105",  # Allow use of hardcoded password to "password"
+    "S106",  # Allow use of hardcoded password in tests
+    "S104",  # Allow binding to all interfaces in tests
+    "S603",  # Allow subprocess calls in tests (e.g. docker compose)
+    "S607",  # Allow starting a process with a partial executable path in tests
+]
+"update_platforms.py" = [
+    "S108",  # Probably insecure usage of temp file/directory - this is a script
+    "S603",  # Use of subprocess without shell=True - this is a script
+    "S607",  # Starting a process with a partial executable path - this is a script
+]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+
+[tool.bandit]
+exclude_dirs = ["./tests/", "./.venv", "./docs/", "./update_platforms.py"]
+tests = ["B201", "B301"]
+skips = ["B101", "B601"]
+
+
+[tool.coverage.run]
+branch = true
+omit = [".*", ".venv"]
+command_line = "-m pytest"
+
+[tool.coverage.report]
+fail_under = 80
+show_missing = true
+
+[tool.coverage.html]
+directory = "coverage_html_report"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-vv"
+
+[tool.uv.build-backend]
+module-name = "simnos"
+module-root = ""
+
+[build-system]
+requires = ["uv_build>=0.9.6,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.14.4", # Linter
+    "ruamel-yaml", # YAML parser
+    "ty>=0.0.1a26", # Type checkers
+    "pytest", # Testing framework
+    "pytest-repeat", # Pytest: Repeat tests
+    "pytest-timeout", # Pytest: Timeout tests
+    "pytest-xdist>=3.8.0", # Pytest: Parallel test execution
+    "bandit",
+    "coverage",
+    "invoke",
+    "pre-commit>=3.8.0,<4.0.0",
+    "pyenchant",
+    "netmiko",
+    "requests",
+    "psutil",
+    "mkdocstrings[crystal,python]",
+    "mkdocs-material",
+    "mkdocs-static-i18n",
+    "pymdown-extensions",
+    "yamllint", # YAML linter
+]

simnos-2.0.0/simnos/__init__.py

@@ -0,0 +1,11 @@
+"""
+This module provides the main classes of the SimNOS library.
+It provides the SimNOS class for creating a fake network
+operating system and the Nos class for creating a network
+operating system object.
+"""
+
+from simnos.core.nos import Nos
+from simnos.core.simnos import SimNOS, simnos
+
+__all__ = ("Nos", "SimNOS", "simnos")

simnos-2.0.0/simnos/core/host.py

@@ -0,0 +1,97 @@
+"""
+This module sets up the host object which is the main object in SIMNOS.
+It provides the methods to start and stop the server instance for the host.
+It also validates the host object using pydantic.
+"""
+
+import logging
+
+from simnos.core.nos import Nos, available_platforms
+from simnos.core.pydantic_models import ModelHost
+
+log = logging.getLogger(__name__)
+
+
+class Host:
+    """
+    Host class to build host instances to use with SIMNOS.
+    """
+
+    def __init__(
+        self,
+        name: str,
+        username: str,
+        password: str,
+        port: int,
+        server: dict,
+        shell: dict,
+        nos: dict,
+        simnos,
+        platform: str | None = None,
+        configuration_file: str | None = None,
+    ) -> None:
+        self.name: str = name
+        self.server_inventory: dict = server
+        self.shell_inventory: dict = shell
+        self.nos_inventory: dict = nos
+        self.username: str = username
+        self.password: str = password
+        self.port: int = port
+        self.simnos = simnos  # SimNOS object
+        self.shell_inventory["configuration"].setdefault("base_prompt", self.name)
+        self.running = False
+        self.server = None
+        self.server_plugin = None
+        self.shell_plugin = None
+        self.nos_plugin = None
+        self.nos = None
+        self.platform: str | None = platform
+        self.configuration_file: str | None = configuration_file
+
+        if self.platform:
+            self.nos_inventory["plugin"] = self.platform
+
+        self._validate()
+
+    def start(self):
+        """Method to start server instance for this host."""
+        self.server_plugin = self.simnos.servers_plugins[self.server_inventory["plugin"]]
+        self.shell_plugin = self.simnos.shell_plugins[self.shell_inventory["plugin"]]
+        if self.platform:
+            self.nos_inventory["plugin"] = self.platform
+        self.nos_plugin = self.simnos.nos_plugins.get(self.nos_inventory["plugin"], self.nos_inventory["plugin"])
+        self.nos = (
+            Nos(filename=self.nos_plugin, configuration_file=self.configuration_file)
+            if not isinstance(self.nos_plugin, Nos)
+            else self.nos_plugin
+        )
+        self.server = self.server_plugin(
+            shell=self.shell_plugin,
+            shell_configuration=self.shell_inventory["configuration"],
+            nos=self.nos,
+            nos_inventory_config=self.nos_inventory.get("configuration", {}),
+            port=self.port,
+            username=self.username,
+            password=self.password,
+            **self.server_inventory["configuration"],
+        )
+        self.server.start()
+        self.running = True
+
+    def stop(self):
+        """Method to stop server instance for this host."""
+        self.server.stop()
+        self.server = None
+        self.running = False
+
+    def _validate(self):
+        """Validate that the host has the required attributes using pydantic"""
+        if self.platform:
+            self._check_if_platform_is_supported(self.platform)
+        ModelHost(**self.__dict__)
+
+    def _check_if_platform_is_supported(self, platform: str):
+        """Check if the platform is supported"""
+        if platform not in available_platforms:
+            msg = f"Platform {platform} is not supported by SIMNOS. Supported platforms are: {available_platforms}"
+            raise ValueError(msg)