# Netutils
<p align="center">
<img src="https://raw.githubusercontent.com/networktocode/netutils/develop/docs/images/icon-Netutils.png" class="logo" height="200px">
<br>
<a href="https://github.com/networktocode/netutils/actions"><img src="https://github.com/networktocode/netutils/actions/workflows/ci.yml/badge.svg?branch=main"></a>
<a href="https://netutils.readthedocs.io/en/latest"><img src="https://readthedocs.org/projects/netutils/badge/"></a>
<a href="https://pypi.org/project/netutils/"><img src="https://img.shields.io/pypi/v/netutils"></a>
<a href="https://pypi.org/project/netutils/"><img src="https://img.shields.io/pypi/dm/netutils"></a>
<br>
</p>
## 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.
Raw data
{
"_id": null,
"home_page": "https://netutils.readthedocs.io",
"name": "netutils",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "netutils, network utils, network utilities, net-utils",
"author": "Network to Code, LLC",
"author_email": "opensource@networktocode.com",
"download_url": "https://files.pythonhosted.org/packages/23/16/b0668e760ea61e6973dae280ac80e830cf51602e54612763592ea55ecfbc/netutils-1.8.1.tar.gz",
"platform": null,
"description": "# Netutils\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/networktocode/netutils/develop/docs/images/icon-Netutils.png\" class=\"logo\" height=\"200px\">\n <br>\n <a href=\"https://github.com/networktocode/netutils/actions\"><img src=\"https://github.com/networktocode/netutils/actions/workflows/ci.yml/badge.svg?branch=main\"></a>\n <a href=\"https://netutils.readthedocs.io/en/latest\"><img src=\"https://readthedocs.org/projects/netutils/badge/\"></a>\n <a href=\"https://pypi.org/project/netutils/\"><img src=\"https://img.shields.io/pypi/v/netutils\"></a>\n <a href=\"https://pypi.org/project/netutils/\"><img src=\"https://img.shields.io/pypi/dm/netutils\"></a>\n <br>\n</p>\n\n## Overview\n\nA 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.\n\n## Documentation\n\nFull web-based HTML documentation for this library can be found over on the [Netutils Docs](https://netutils.readthedocs.io) website:\n\n- [User Guide](https://netutils.readthedocs.io/en/latest/user/lib_overview/) - Overview, Using the library, Getting Started.\n- [Administrator Guide](https://netutils.readthedocs.io/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the library.\n- [Developer Guide](https://netutils.readthedocs.io/en/latest/dev/contributing/) - Extending the library, Code Reference, Contribution Guide.\n- [Release Notes / Changelog](https://netutils.readthedocs.io/en/latest/admin/release_notes/).\n- [Frequently Asked Questions](https://netutils.readthedocs.io/en/latest/user/faq/).\n\n### Contributing to the Docs\n\nAll 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.\n\nIf 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.\n\nAny PRs with fixes or improvements are very welcome!\n\n## Questions\n\nFor 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.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Common helper functions useful in network automation.",
"version": "1.8.1",
"project_urls": {
"Documentation": "https://netutils.readthedocs.io",
"Homepage": "https://netutils.readthedocs.io",
"Repository": "https://github.com/networktocode/netutils"
},
"split_keywords": [
"netutils",
" network utils",
" network utilities",
" net-utils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0c2bd00131e943a63173a1a7171921463a294ae818c9a52e209f0651cee8195",
"md5": "f8920574631ee8f6e8f28cb3ebe6666a",
"sha256": "b1d6864a7512c3def0e12a2a879f12ccca9b5077d482f591c56d0171542aa040"
},
"downloads": -1,
"filename": "netutils-1.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8920574631ee8f6e8f28cb3ebe6666a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 502112,
"upload_time": "2024-04-19T18:26:56",
"upload_time_iso_8601": "2024-04-19T18:26:56.399804Z",
"url": "https://files.pythonhosted.org/packages/b0/c2/bd00131e943a63173a1a7171921463a294ae818c9a52e209f0651cee8195/netutils-1.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2316b0668e760ea61e6973dae280ac80e830cf51602e54612763592ea55ecfbc",
"md5": "177d9e50cda421b581e978ec0869778f",
"sha256": "20d0cd9bf3a11588e77266c4aca93b460c732e12c4449e48213f22ab32d78921"
},
"downloads": -1,
"filename": "netutils-1.8.1.tar.gz",
"has_sig": false,
"md5_digest": "177d9e50cda421b581e978ec0869778f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 487491,
"upload_time": "2024-04-19T18:26:58",
"upload_time_iso_8601": "2024-04-19T18:26:58.406905Z",
"url": "https://files.pythonhosted.org/packages/23/16/b0668e760ea61e6973dae280ac80e830cf51602e54612763592ea55ecfbc/netutils-1.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-19 18:26:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "networktocode",
"github_project": "netutils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "netutils"
}
JSON
