networktocode / nornir-pyntc

Pyntc Plugin for Nornir

nornir-pyntc

Overview

A pyntc plugin for Nornir.

Documentation

Full web-based HTML documentation for this library can be found over on the Nornir-Pyntc Docs website:

• User Guide - Overview, Using the library, Getting Started.
• Administrator Guide - How to Install, Configure, Upgrade, or Uninstall the library.
• Developer Guide - Extending the library, Code Reference, Contribution Guide.
• Release Notes / Changelog.
• Frequently Asked Questions.

Contributing to the Docs

All the Markdown source for the library documentation can be found under the docs folder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.

If you need to view the fully generated documentation site, you can build it with mkdocs. A container hosting the docs will be started using the invoke commands (details in the Development Environment Guide) on http://localhost:8001. As your changes are saved, the live docs will be automatically reloaded.

Any PRs with fixes or improvements are very welcome!

Questions

For any questions or comments, please check the FAQ first. Feel free to also swing by the Network to Code Slack (channel #networktocode), sign up here if you don't have an account.

nornir-pyntc's Issues

Code review feedback

• What's the planned release version of this? 1.0.0? Currently versioned at 0.0.1, which seems pessimistic. :-)
• Linting and GHA look good
  • Looks like you're doing a lot of type annotations in the code, which is terrific - have you considered adding mypy to the set of linters in use?
• No real unit tests that I see - planning to add any? Looking at some of the other Nornir plugins out there the level of testing seems to vary widely, but I feel like it should be possible to have decent coverage here relatively simply by mocking out pyntc calls.
• I'd suggest reviewing all of the docstrings in this module for correctness - a few examples:
  • https://github.com/networktocode-llc/nornir-pyntc/blob/develop/nornir_pyntc/tasks/pyntc_config.py#L8 I'm not sure I follow the significance of the statement config_list is being DEPRECATED in pyntc config can take str or list.?
  • https://github.com/networktocode-llc/nornir-pyntc/blob/develop/nornir_pyntc/tasks/pyntc_install_os.py#L28, https://github.com/networktocode-llc/nornir-pyntc/blob/develop/nornir_pyntc/tasks/pyntc_save.py#L15 - seems incorrect, as these tasks return a Result, not a bool?
  • https://github.com/networktocode-llc/nornir-pyntc/blob/develop/nornir_pyntc/tasks/pyntc_reboot.py#L17 - seems incorrect, as this function won't raise any exception (due to broad except Exception clause) but will instead return a failed Result?

Once pyntc 1.0.0 comes out, create 2.0 major release and deprecate _list commands and reboot timer

pyntc 1.0.0 cleans up the backend logic in multiple methods, it also deprecates _list methods. This lib should follow suit.

Get new project logo

Environment

• nornir-pyntc version: 1.0.1

Use Case

Currently reusing pyntc logo, need to create a new logo for this project and update readthedocs to avoid confusion between pyntc and nornir-pyntc.

show_list broken

Environment

• Python version: 3.11.0
• nornir-pyntc version: 1.0.1

Expected Behavior

pyntc_show_list works.

Observed Behavior

pyntc_show_list broke when the underlying pyntc show_list() was deprecated.

output now shows

/usr/local/lib/python3.11/site-packages/pyntc/devices/eos_device.py:563: DeprecationWarning: show_list() is deprecated; use show().
  warnings.warn("show_list() is deprecated; use show().", DeprecationWarning)
vvvv ceos1: pyntc_show_list ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
^^^^ END pyntc_show_list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
vvvv ceos2: pyntc_show_list ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
^^^^ END pyntc_show_list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Options to address

1. Deprecate pyntc_show_list and update documentation accordingly
2. Fix pyntc_show_list and correct integration tests to catch this sort of item in the future.