Skip to content

Commit 753ab89

Browse files
committed
Update Docs before release
1 parent 6b43bac commit 753ab89

File tree

4 files changed

+290
-275
lines changed

4 files changed

+290
-275
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,27 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/)
1313
### Security
1414

1515

16+
## [0.0.10]
17+
### Added
18+
- Cisco WLC/AireOS Driver
19+
- [Poetry](https://python-poetry.org/)
20+
- `boot_options` property
21+
### Changed
22+
- Super calls migrated to Python 3 syntax
23+
- Moved templates package inside of utils package
24+
- Moved converters package inside of utils package
25+
- Moved constants to modules that used them instead of having separate modules
26+
### Deprecated
27+
- The `get_boot_options` method; replaced by `boot_options` property
28+
### Removed
29+
- Support for Python 2
30+
- `strip_unicode` function since support is not for Python 3
31+
### Fixed
32+
- All Unittests
33+
- IOS `enable` method failure condition when disabled
34+
### Security
35+
36+
1637
## [0.0.9] - 2017-11-28
1738
### Added
1839
- Method to fully install an OS on a device.

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
[![Build Status](https://travis-ci.org/networktocode/pyntc.svg?branch=master)](https://travis-ci.org/networktocode/pyntc) [![Coverage Status](https://coveralls.io/repos/github/networktocode/pyntc/badge.svg?branch=master)](https://coveralls.io/github/networktocode/pyntc?branch=master)
1+
[![Build Status](https://travis-ci.org/networktocode/pyntc.svg?branch=master)](https://travis-ci.org/networktocode/pyntc)
2+
[![Coverage Status](https://coveralls.io/repos/github/networktocode/pyntc/badge.svg?branch=master)](https://coveralls.io/github/networktocode/pyntc?branch=master)
23

34
# Introduction
45

@@ -13,20 +14,20 @@ It's main purpose is to simplify the execution of common tasks including:
1314

1415
# Supported Platforms
1516

17+
* Cisco AireOS - uses netmiko (SSH)
18+
* Cisco ASA - uses netmiko (SSH)
1619
* Cisco IOS platforms - uses netmiko (SSH)
1720
* Cisco NX-OS - uses pynxos (NX-API)
1821
* Arista EOS - uses pyeapi (eAPI)
1922
* Juniper Junos - uses PyEz (NETCONF)
2023
* F5 Networks - uses f5-sdk (ReST)
2124

22-
It is a multi-vendor AND multi-API library.
23-
2425
# Installing pyntc
2526

2627
Option 1:
2728

2829
```
29-
"sudo pip install pyntc" or "sudo pip install pyntc --upgrade"
30+
"pip install pyntc" or "pip install pyntc --upgrade"
3031
```
3132

3233
Option 2:
@@ -43,7 +44,7 @@ poetry install
4344

4445
There are two ways to get started with pyntc.
4546

46-
The first way is to use the `ntc_device` object. Just pass in all required parameters to the object to initialize your device. Here we are showing the import, but renaming the object to `NTC`.
47+
The first way is to use the `ntc_device` object. Just pass in all required parameters to the object to initialize your device. Here we are showing the import, but renaming the object to `NTC`.
4748

4849
```
4950
>>> from pyntc import ntc_device as NTC
@@ -53,10 +54,13 @@ The first way is to use the `ntc_device` object. Just pass in all required para
5354
Like many libraries, we need to pass in the host/IP and credentials. Because this is a multi-vendor/API library, we also use the `device_type` parameter to identify which device we are building an instance of.
5455

5556
pyntc currently supports four device types:
57+
* cisco_aireos_ssh
58+
* cisco_asa_ssh
5659
* cisco_ios_ssh
5760
* cisco_nxos_nxapi
5861
* arista_eos_eapi
5962
* juniper_junos_netconf
63+
* f5_tmos_icontrol
6064

6165
The example below shows how to build a device object when working with a Cisco IOS router.
6266

0 commit comments

Comments
 (0)