Napalm driver for FSOS using SSH
[![PyPI](https://img.shields.io/pypi/v/napalm-fsos-ssh.svg)](https://pypi.python.org/pypi/napalm-fsos-ssh)
[![PyPI versions](https://img.shields.io/pypi/pyversions/napalm-fsos-ssh.svg)](https://pypi.python.org/pypi/napalm-fsos-ssh)
[![Python test](https://github.com/napalm-automation-community/napalm-fsos-ssh/actions/workflows/test.yml/badge.svg)](https://github.com/napalm-automation-community/napalm-fsos-ssh/actions/workflows/test.yml)
[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
# Warning
This driver has been tested only on S3900 24T4S with version 1.7.3
# Install
```
pip install napalm-fsos-ssh
```
# Dev
## Devcontainer
A devcontainer is available
## Standard
Install [Poetry](https://python-poetry.org/docs/master/#installing-with-the-official-installer)
Install and setup dependencies
```
poetry install
poetry shell
pre-commit install
```
### Run unit test
```
poetry run pytest
```
### Run linter & formatter
```
poetry run ruff format .
poetry run ruff check .
```
# Switch configuration
In order to use the driver you need to enable ssh:
```
ip ssh server enable
```
You also need to configure a username and password with ro permission to authenticate with ssh
You can change privilege level regarding driver capability you needs
```
username <your_username> password 0 <your_password>
username <your_username> privilege 15
```
# Contributing
We welcome and encourage contributions to this project! Please read the [Contributing guide](CONTRIBUTING.md). Also make sure to check the [Code of Conduct](CODE_OF_CONDUCT.md) and adhere to its guidelines
# Security
See [SECURITY.md](SECURITY.md) file for details.
# Licence
The code is under CeCILL license.
You can find all details here: https://cecill.info/licences/Licence_CeCILL_V2.1-en.html
# Credits
Copyright © Ludovic Ortega, 2022
Contributor(s):
-Ortega Ludovic - ludovic.ortega@adminafk.fr
Raw data
{
"_id": null,
"home_page": "https://github.com/napalm-automation-community/napalm-fsos-ssh",
"name": "napalm-fsos-ssh",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>3.8",
"maintainer_email": null,
"keywords": "napalm, fsos, netmiko",
"author": "Ludovic Ortega",
"author_email": "ludovic.ortega@adminafk.fr",
"download_url": "https://files.pythonhosted.org/packages/30/fe/ec3ac999437876c7e10242db56994a931078e9a5a1aeca57e52704b9a7f7/napalm_fsos_ssh-1.2.0.tar.gz",
"platform": null,
"description": "Napalm driver for FSOS using SSH\n\n[![PyPI](https://img.shields.io/pypi/v/napalm-fsos-ssh.svg)](https://pypi.python.org/pypi/napalm-fsos-ssh)\n[![PyPI versions](https://img.shields.io/pypi/pyversions/napalm-fsos-ssh.svg)](https://pypi.python.org/pypi/napalm-fsos-ssh)\n[![Python test](https://github.com/napalm-automation-community/napalm-fsos-ssh/actions/workflows/test.yml/badge.svg)](https://github.com/napalm-automation-community/napalm-fsos-ssh/actions/workflows/test.yml)\n[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n# Warning\nThis driver has been tested only on S3900 24T4S with version 1.7.3\n\n# Install\n```\npip install napalm-fsos-ssh\n```\n\n# Dev\n## Devcontainer\nA devcontainer is available\n\n## Standard\nInstall [Poetry](https://python-poetry.org/docs/master/#installing-with-the-official-installer)\n\nInstall and setup dependencies\n```\npoetry install\npoetry shell\npre-commit install\n```\n\n### Run unit test\n```\npoetry run pytest\n```\n\n### Run linter & formatter\n```\npoetry run ruff format . \npoetry run ruff check .\n```\n\n# Switch configuration\n\nIn order to use the driver you need to enable ssh:\n```\nip ssh server enable\n```\n\nYou also need to configure a username and password with ro permission to authenticate with ssh\nYou can change privilege level regarding driver capability you needs\n```\nusername <your_username> password 0 <your_password>\nusername <your_username> privilege 15\n```\n\n# Contributing\n\nWe welcome and encourage contributions to this project! Please read the [Contributing guide](CONTRIBUTING.md). Also make sure to check the [Code of Conduct](CODE_OF_CONDUCT.md) and adhere to its guidelines\n\n# Security\n\nSee [SECURITY.md](SECURITY.md) file for details.\n\n# Licence\n\nThe code is under CeCILL license.\n\nYou can find all details here: https://cecill.info/licences/Licence_CeCILL_V2.1-en.html\n\n# Credits\n\nCopyright \u00a9 Ludovic Ortega, 2022\n\nContributor(s):\n\n-Ortega Ludovic - ludovic.ortega@adminafk.fr\n",
"bugtrack_url": null,
"license": "CeCILL",
"summary": "Napalm driver for FSOS through SSH",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/napalm-automation-community/napalm-fsos-ssh",
"Repository": "https://github.com/napalm-automation-community/napalm-fsos-ssh"
},
"split_keywords": [
"napalm",
" fsos",
" netmiko"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4a7cfad5c114c91519ad954e07988275f51bb43e9c0c9af0c6ca68504d0b28c",
"md5": "28785d1378efa6d10115e9f6a8bad04d",
"sha256": "b50d0e05b2a307751a4785beea2784eacfe5c51dd6b3229472e0baf2e10d40b6"
},
"downloads": -1,
"filename": "napalm_fsos_ssh-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28785d1378efa6d10115e9f6a8bad04d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>3.8",
"size": 48682,
"upload_time": "2024-04-16T23:11:44",
"upload_time_iso_8601": "2024-04-16T23:11:44.082478Z",
"url": "https://files.pythonhosted.org/packages/d4/a7/cfad5c114c91519ad954e07988275f51bb43e9c0c9af0c6ca68504d0b28c/napalm_fsos_ssh-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30feec3ac999437876c7e10242db56994a931078e9a5a1aeca57e52704b9a7f7",
"md5": "f00e423a9436e4aed71e6181a95325e4",
"sha256": "9b213a122ba054082db627a9dbd1b44193d173ce87e267eae1624857246a6efe"
},
"downloads": -1,
"filename": "napalm_fsos_ssh-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f00e423a9436e4aed71e6181a95325e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>3.8",
"size": 25855,
"upload_time": "2024-04-16T23:11:45",
"upload_time_iso_8601": "2024-04-16T23:11:45.261987Z",
"url": "https://files.pythonhosted.org/packages/30/fe/ec3ac999437876c7e10242db56994a931078e9a5a1aeca57e52704b9a7f7/napalm_fsos_ssh-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 23:11:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "napalm-automation-community",
"github_project": "napalm-fsos-ssh",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "napalm-fsos-ssh"
}