Merge pull request #285 from networktocode/develop

Release 1.0.0

Author: jeffkala

.github/workflows/ci.yml

@@ -188,8 +188,8 @@ jobs:
       - name: "Run Tests"
         run: "poetry run invoke pytest"
     needs:
-  # Remove everything but pylint once pylint is passing.
-  #     - "pylint"
+      # Remove everything but pylint once pylint is passing.
+      # - "pylint"
       - "bandit"
       - "pydocstyle"
       - "flake8"

docs/admin/install.md

@@ -18,5 +18,5 @@ poetry install
 Option 3: Install from a GitHub branch, such as develop as shown below.
 
 ```bash
-$ pip install git+https://github.com/networktocode/netutils.git@develop
+$ pip install git+https://github.com/networktocode/pyntc.git@develop
 ```

docs/admin/release_notes/version_1_0.md

@@ -0,0 +1,21 @@
+# v1.0 Release Notes
+
+## [1.0.0] 04-2023
+
+### Added
+
+- [270](https://github.com/networktocode/pyntc/pull/270) Add additional properties to ASA and AIREOS.
+- [271](https://github.com/networktocode/pyntc/pull/271) Add default logging for all devices and overall library.
+- [280](https://github.com/networktocode/pyntc/pull/280) Add the `wait_for_reload` argument from `reboot` method throughout library. Defaults to False to keep current code backward compatible, If set to True the reboot method waits for the device to finish the reboot before returning.
+
+### Changed
+- [280](https://github.com/networktocode/pyntc/pull/280) Changed from relative imports to absolute imports.
+- [282](https://github.com/networktocode/pyntc/pull/282) Update initial pass at pylint.
+
+### Deprecated
+
+- [269](https://github.com/networktocode/pyntc/pull/269) Remove `show_list` and `config_list` methods asa and ios. Add default functionality to `show` and `config` to handle str and list.
+- [275](https://github.com/networktocode/pyntc/pull/275) Remove python ABC (abstract base classes) as they were not required.
+- [275](https://github.com/networktocode/pyntc/pull/275) Remove `show_list` and `config_list` methods for the rest of device drivers. Add default functionality to `show` and `config` to handle str and list.
+- [280](https://github.com/networktocode/pyntc/pull/280) Remove the use of `signal` modules within Cisco drivers. This will allow for reboots to be able to be handled within threads.
+- [280](https://github.com/networktocode/pyntc/pull/280) Remove the `timer` argument from `reboot` method throughout library. Compatibility matrix on which versions, vendors support it became to much to maintain.

docs/user/lib_getting_started.md

@@ -173,12 +173,12 @@ On an IOS device:
 
 ### Sending Multiple Commands
 
-- `show_list` method
+- `show` method
 
 ```python
 >>> cmds = ['show hostname', 'show run int Eth2/1']
 
->>> data = nxs1.show_list(cmds, raw_text=True)
+>>> data = nxs1.show(cmds)
 ```
 
 ```python
@@ -197,15 +197,15 @@ interface Ethernet2/1
 
 ### Config Commands
 
-- Use `config` and `config_list`
+- Use `config`
 
 ```python
 >>> csr1.config('hostname testname')
 >>>
 ```
 
 ```python
->>> csr1.config_list(['interface Gi3', 'shutdown'])
+>>> csr1.config(['interface Gi3', 'shutdown'])
 >>>
 ```
 
@@ -283,11 +283,11 @@ Backup current running configuration and store it locally
 Reboot target device
 
 Parameters:
-  - `timer=0` by default
-  - `confirm=False` by default
+  - `wait_for_reload=False` by default. If `True` function waits for device to recover from reboot before returning.
+
 
 ```python
->>> csr1.reboot(confirm=True)
+>>> csr1.reboot(wait_for_reload=False)
 >>>
 ```
 

mkdocs.yml

@@ -112,6 +112,7 @@ nav:
           - v0.18: "admin/release_notes/version_0_18.md"
           - v0.19: "admin/release_notes/version_0_19.md"
           - v0.20: "admin/release_notes/version_0_20.md"
+          - v1.0: "admin/release_notes/version_1_0.md"
   - Developer Guide:
       - Extending the Library: "dev/extending.md"
       - Contributing to the Library: "dev/contributing.md"

poetry.lock

@@ -1,4 +1,4 @@
-"""Kickoff functions for getting instancs of device objects."""
+"""Kickoff functions for getting instance of device objects."""
 
 import os
 import warnings