Skip to main content

Network Automation Collection

Project description

nettowel

Collection of useful network automation functions

⚠️ nettowel is under heavy construction and not production ready. Feedback is highly appreciated.

Install

You can install it directly from pypi

pip install nettowel

To reduce the dependencies the extra dependencies are grouped

The following groups are available (more details in the pyproject.toml):

  • full
  • jinja
  • ttp
  • textfsm
  • napalm
  • netmiko
  • scrapli
  • nornir
  • pandas
pip install nettowel[jinja]
pip install nettowel[full]

Install from source

git clone ....
cd nettowel
poetry install
poetry run nettowel --help

Help and shell auto-completion

Thanks to the library typer, nettowel comes with a nice help and autocompletion install

help

Features

Many features are not implemented yet and many features will come.

Jinja2

render

jinja rendering 1

jinja rendering 2

validate

jinja validate

variables

jinja variables

TTP

render

ttp render

Netmiko

cli

netmiko cli

autodetect

netmiko autodetect

device-types

netmiko device types

RESTCONF

get

restconf get

patch, delete

restconf patch delete

post, put

restconf post put

ipaddress

ip-info

ip info

network-info

network info

Help

Help QRcode

Settings

A dotenv file can be used as a settings file. The file can also be provided with the option --dotenv.

environment settings

Piping

piping

Building CLI Docs

At the moment typer-cli is not ready for typer 0.4.0

typer nettowel/cli/main.py utils docs --name nettowel --output CLI.md

Contributing

Run tests:

make tests

Bump version:

Steps: patch, minor, major, prepatch, preminor, premajor, prerelease.

make bump ARGS=patch

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nettowel-0.4.2.tar.gz (20.1 kB view hashes)

Uploaded Source

Built Distribution

nettowel-0.4.2-py3-none-any.whl (27.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page