Metadata-Version: 2.3
Name: napalm-fsos-ssh
Version: 1.3.0
Summary: Napalm driver for FSOS through SSH
Project-URL: Homepage, https://github.com/napalm-automation-community/napalm-fsos-ssh
Project-URL: Repository, https://github.com/napalm-automation-community/napalm-fsos-ssh
Project-URL: Issues, https://github.com/napalm-automation-community/napalm-fsos-ssh/issues
Author-email: Ludovic Ortega <ludovic.ortega@adminafk.fr>
License-File: LICENSE
License-File: LICENSE.fr
Keywords: fsos,napalm,netmiko
Classifier: License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Utilities
Requires-Python: <4.0.0,>=3.9
Requires-Dist: napalm<5.1,>=4.0
Provides-Extra: dev
Requires-Dist: pytest-cov~=5.0.0; extra == 'dev'
Requires-Dist: pytest~=8.3.3; extra == 'dev'
Requires-Dist: ruff~=0.7.0; extra == 'dev'
Description-Content-Type: text/markdown

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 [uv](https://docs.astral.sh/uv/getting-started/installation/)

Install and setup dependencies with `uv sync`

### Run unit test
```
uv run pytest --cov
```

### Run ruff
```
uv run ruff format . 
uv 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
