https://github.com/networktocode/netutils

Python library that is a collection of functions and objects for common network automation tasks.
https://github.com/networktocode/netutils

Last synced: 3 days ago
JSON representation

Python library that is a collection of functions and objects for common network automation tasks.

• Host: GitHub
• URL: https://github.com/networktocode/netutils
• Owner: networktocode
• License: other
• Created: 2021-05-08T13:02:34.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2024-05-27T14:27:35.000Z (8 months ago)
• Last Synced: 2024-05-30T01:17:51.321Z (7 months ago)
• Language: Python
• Homepage: https://netutils.readthedocs.io/
• Size: 2.94 MB
• Stars: 205
• Watchers: 16
• Forks: 47
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Netutils



  

  


  

  

  

  

  




## Overview

A Python library that is a collection of functions that are used in the common network automation tasks. Tasks such as converting a BGP ASN to and from dotted format, normalizing an interface name, or "type 5" encrypting a password. The intention is to centralize these functions while keeping the library light.

## Documentation

Full web-based HTML documentation for this library can be found over on the [Netutils Docs](https://netutils.readthedocs.io) website:

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

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

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

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

- [Frequently Asked Questions](https://netutils.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/netutils/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://netutils.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://netutils.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.