ntc-templates the package

[ogenstad]

I'm missing a way to distribute the templates in a way which doesn't include github (which is currently blocked from my environment).

I had a thought of optionally treating ntc-templates as a Python package. This can be done without impacting the project in any other way. The setup.py file gets a bit strange though.

Another reason to have this is to make it easier to use the ntc-templates outside of Ansible. In the future the Ansible module could be changed to use this package instead.

To test:

python setup.py sdist
pip install dist/ntc_templates-1.0.0.tar.gz

An example of how the package can be used:

from ntc_templates.parse import parse_output

data = """
Capability Codes: R - Router, T - Trans Bridge, B- Source Route Bridge
           S - Switch, H - Host, I - IGMP, r - Repeater, P - Phone

Device ID         Local Intrfce Holdtme    Capability   Platform   Port ID
R1-PBX            Gig 1/0/10    144          R S I      2811       Fas 0/0
TS-1              Gig 1/0/39    122          R          2611       Eth 0/1
Cisco-WAP-N       Gig 1/0/1     120          T I        AIR-AP125  Gig 0
SEP04FE7F689D33   Gig 1/0/2     125          H P        IP Phone   Port 1
SEP000DBC50FCD1   Gig 1/0/4     147          H P        IP Phone   Port 1
SEP00124362C4D2   Gig 1/0/42    147          H P        IP Phone   Port 1
"""

s = parse_output(platform='cisco_ios', command='show cdp neighbors', data=data)

>>> s
[{'neighbor_interface': 'Fas 0/0', 'local_interface': 'Gig 1/0/10', 'neighbor': 'R1-PBX'}, {'neighbor_interface': 'Eth 0/1', 'local_interface': 'Gig 1/0/39', 'neighbor': 'TS-1'}, {'neighbor_interface': 'Gig 0', 'local_interface': 'Gig 1/0/1', 'neighbor': 'Cisco-WAP-N'}, {'neighbor_interface': 'Port 1', 'local_interface': 'Gig 1/0/2', 'neighbor': 'SEP04FE7F689D33'}, {'neighbor_interface': 'Port 1', 'local_interface': 'Gig 1/0/4', 'neighbor': 'SEP000DBC50FCD1'}, {'neighbor_interface': 'Port 1', 'local_interface': 'Gig 1/0/42', 'neighbor': 'SEP00124362C4D2'}]

Perhaps the function of the names could be changed.

Probably we'll just raise an exception if someone tries to use a template which hasn't been created. Perhaps also print the version of ntc_templates so that it's easy to point people to a later version if a template already exists.

>>> s = parse_output(platform='cisco_ios', command='show unsupported feature', data=data)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/patrick/.virtualenvs/scratch/lib/python2.7/site-packages/ntc_templates/parse.py", line 40, in parse_output
    raise Exception('Unable to parse command "%s" on platform %s - %s' % (command, platform, str(e)))
Exception: Unable to parse command "show unsupported feature" on platform cisco_ios - No template found for attributes: "{'Platform': 'cisco_ios', 'Command': 'show unsupported feature'}"
>>>

If this is supported more files will need to be added to the .gitignore file and perhaps the README.md should be changed to .rst for pypi support.

[jedelman8]

Totally on board with this and de-coupling the templates from the ntc-ansible directory was done for this reason (trigger team asked).

We now need a mechanism in the ansible module to find the templates (assuming pip / setup.py install) as first option then use the existing way as a second option...like a auto loader / finder function for templates. I can work on this and pretty sure I've done it already.

And yes love the fact they can now be used in Python as you show below.

Getting on a flight now, but looks like this upcoming week will be a fun one for testing. Thanks man. Great stuff.

On May 14, 2016, at 6:28 AM, Patrick Ogenstad [email protected] wrote:

I'm missing a way to distribute the templates in a way which doesn't include github (which is currently blocked from my environment).

I had a thought of optionally treating ntc-templates as a Python package. This can be done without impacting the project in any other way. The setup.py file gets a bit strange though.

Another reason to have this is to make it easier to use the ntc-templates outside of Ansible. In the future the Ansible module could be changed to use this package instead.

To test:

python setup.py sdist
pip install dist/ntc_templates-1.0.0.tar.gz
An example of how the package can be used:

from ntc_templates.parse import parse_output

data = """
Capability Codes: R - Router, T - Trans Bridge, B- Source Route Bridge
S - Switch, H - Host, I - IGMP, r - Repeater, P - Phone

Device ID Local Intrfce Holdtme Capability Platform Port ID
R1-PBX Gig 1/0/10 144 R S I 2811 Fas 0/0
TS-1 Gig 1/0/39 122 R 2611 Eth 0/1
Cisco-WAP-N Gig 1/0/1 120 T I AIR-AP125 Gig 0
SEP04FE7F689D33 Gig 1/0/2 125 H P IP Phone Port 1
SEP000DBC50FCD1 Gig 1/0/4 147 H P IP Phone Port 1
SEP00124362C4D2 Gig 1/0/42 147 H P IP Phone Port 1
"""

s = parse_output(platform='cisco_ios', command='show cdp neighbors', data=data)

s
[{'neighbor_interface': 'Fas 0/0', 'local_interface': 'Gig 1/0/10', 'neighbor': 'R1-PBX'}, {'neighbor_interface': 'Eth 0/1', 'local_interface': 'Gig 1/0/39', <
span class="pl-pds">'neighbor': 'TS-1'}, {'neighbor_interface': 'Gig 0', 'local_interface': 'Gig 1/0/1', 'neighbor': 'Cisco-WAP-N'}, {'neighbor_interface': 'Port 1', 'loc
al_interface': 'Gig 1/0/2', 'neighbor': 'SEP04FE7F689D33'}, {'neighbor_interface': 'Port 1', 'local_interface': 'Gig 1/0/4', 'neighbor': 'SEP000DBC50FCD1'}, {'neighbor_interface
': 'Port 1', 'local_interface': 'Gig 1/0/42', 'neighbor': 'SEP00124362C4D2'}]
Perhaps the function of the names could be changed.

Probably we'll just raise an exception if someone tries to use a template which hasn't been created. Perhaps also print the version of ntc_templates so that it's easy to point people to a later version if a template already exists.

s = parse_output(platform='cisco_ios', command='show unsupported feature', data=data)
Traceback (most recent call last):
File "", line 1, in
File "/Users/patrick/.virtualenvs/scratch/lib/python2.7/site-packages/ntc_templates/parse.py", line 40, in parse_output
raise Exception('Unable to parse command "%s" on platform %s - %s' % (command, platform, str(e)))
Exception: Unable to parse command "show unsupported feature" on platform cisco_ios - No template found for attributes: "{'Platform': 'cisco_ios', 'Command': 'show unsupported feature'}"

If this is supported more files will need to be added to the .gitignore file and perhaps the README.md should be changed to .rst for pypi support.

You can view, comment on, or merge this pull request online at:

#6

Commit Summary

ntc-templates the package
File Changes

A HISTORY.rst (7)
A MANIFEST.in (1)
A ntc_templates/init.py (3)
A ntc_templates/parse.py (46)
A pylama.ini (7)
A setup.py (59)
Patch Links:

https://github.com/networktocode/ntc-templates/pull/6.patch
https://github.com/networktocode/ntc-templates/pull/6.diff
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub

[ogenstad]

By the way the setup code would look a lot better if we would move the current "templates" directory into the ntc_templates directory. But this would break current stuff and can perhaps be done later.

Also forgot to mention, the above Python code won't work if your current directory is the repo, you will have to move outside of that directory in order to test.