https://github.com/networktocode/nornir-pyntc

Pyntc Plugin for Nornir
https://github.com/networktocode/nornir-pyntc

Last synced: 10 days ago
JSON representation

Pyntc Plugin for Nornir

• Host: GitHub
• URL: https://github.com/networktocode/nornir-pyntc
• Owner: networktocode
• License: other
• Created: 2022-02-15T22:08:12.000Z (almost 3 years ago)
• Default Branch: develop
• Last Pushed: 2024-01-03T16:29:12.000Z (about 1 year ago)
• Last Synced: 2024-11-07T22:09:27.239Z (2 months ago)
• Language: Python
• Homepage: https://nornir-pyntc.readthedocs.io/en/latest/
• Size: 490 KB
• Stars: 3
• Watchers: 8
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# 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](https://nornir-pyntc.readthedocs.io) website:

- [User Guide](https://nornir-pyntc.readthedocs.io/en/latest/user/lib_overview/) - Overview, Using the library, Getting Started.

- [Administrator Guide](https://nornir-pyntc.readthedocs.io/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the library.

- [Developer Guide](https://nornir-pyntc.readthedocs.io/en/latest/dev/contributing/) - Extending the library, Code Reference, Contribution Guide.

- [Release Notes / Changelog](https://nornir-pyntc.readthedocs.io/en/latest/admin/release_notes/).

- [Frequently Asked Questions](https://nornir-pyntc.readthedocs.io/en/latest/user/faq/).

### Contributing to the Docs

All the Markdown source for the library documentation can be found under the [docs](https://github.com/networktocode/nornir-pyntc/tree/develop/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](https://www.mkdocs.org/). A container hosting the docs will be started using the invoke commands (details in the [Development Environment Guide](https://nornir-pyntc.readthedocs.io/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](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](https://nornir-pyntc.readthedocs.io/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#networktocode`), sign up [here](http://slack.networktocode.com/) if you don't have an account.