<commit_before>[![PyPI](https://img.shields.io/pypi/v/pyexos.svg)](https://pypi.python.org/pypi/pyEXOS)
[![Build Status](https://travis-ci.org/LINXNet/pyexos.svg?branch=master)](https://travis-ci.org/LINXNet/pyexos)
[![Coverage Status](https://coveralls.io/repos/github/LINXNet/pyexos/badge.svg?branch=master)](https://coveralls.io/github/LINXNet/pyexos?branch=master)


# pyEXOS

Python library to manage Extreme Networks devices running EXOS

## Requirements

### Python
* netmiko >= 1.4.2

### Extreme Networks
* EXOS version == 16.2

## Install

### Install via pip
```bash
pip install pyEXOS
```

### Upgrade via pip
```bash
pip install --upgrade pyEXOS
```

## Documentation

### Connect to remote device
```python
>>> from pyEXOS import EXOS
>>> device = EXOS(hostname='192.168.1.222', username='admin', password='<PASSWORD>', port=22, timeout=10)<commit_msg>adding telnet example to readme file<commit_after>[![PyPI](https://img.shields.io/pypi/v/pyexos.svg)](https://pypi.python.org/pypi/pyEXOS)
[![Build Status](https://travis-ci.org/LINXNet/pyexos.svg?branch=master)](https://travis-ci.org/LINXNet/pyexos)
[![Coverage Status](https://coveralls.io/repos/github/LINXNet/pyexos/badge.svg?branch=master)](https://coveralls.io/github/LINXNet/pyexos?branch=master)


# pyEXOS

Python library to manage Extreme Networks devices running EXOS

## Requirements

### Python
* netmiko >= 1.4.2

### Extreme Networks
* EXOS version == 16.2

## Install

### Install via pip
```bash
pip install pyEXOS
```

### Upgrade via pip
```bash
pip install --upgrade pyEXOS
```

## Documentation

### Connect to remote device via SSH
```python
>>> from pyEXOS import EXOS
>>> device = EXOS(hostname='192.168.1.222', username='admin', password='<PASSWORD>', port=22, timeout=10)
>>> device.open()
```

### Connect to remote device via Telnet
```python
>>> from pyEXOS import EXOS
>>> device = EXOS(hostname='192.168.1.222', username='admin', password='<PASSWORD>', protocol='telnet', port=23, timeout=10)
{'fraction_non_alphanumeric': 0.1860231271995978, 'fraction_numerical': 0.027149321266968326, 'mean_word_length': 5.503267973856209, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 29, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 3, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6283847', 'n_tokens_mistral': 772, 'n_tokens_neox': 696, 'n_words': 137}