cisco-config-parser 2.2__tar.gz → 2.2.1__tar.gz

{cisco_config_parser-2.2 → cisco_config_parser-2.2.1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: cisco_config_parser
-Version: 2.2
-Summary: This Package Will Parse Cisco IOS, IOS-XE, IOS-XR and NXOS Configuration File.
+Version: 2.2.1
+Summary: This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format
 Home-page: https://github.com/arezazadeh/cisco_config_parser
 Author: Ahmad Rezazadeh
 Author-email: ahmad@klevernet.io
@@ -9,10 +9,19 @@ License: MIT License
 Description-Content-Type: text/markdown
 
 # Cisco Configuration Parser
-## This Package Will Parse Cisco IOS, IOS-XE, IOS-XR, and NXOS Configuration File.
 
+This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format
+
+##  New Version 2.0 
+
+## Install the package
+
+https://pypi.org/project/cisco-config-parser/
+
+```bash
+pip install cisco-config-parser
+```
 
-# New Version 2.0 
 
 ## Classes in this library
 
@@ -93,9 +102,6 @@ for i in eigrp:
 
 ```
 
-
-
-
 ### 1. Layer3 Interfaces:
 - added interface details - returns dict of all layer3 interfaces
 - methods are unified 
@@ -136,7 +142,7 @@ None
 <hr>
 <hr>
 
-# Old Version < 2.0  
+## Old Version < 2.0  
 
 There are two ways to parse the config, 1, SSH which is not recommended, and 2, feeding the running-config file 
 
@@ -169,14 +175,6 @@ pass the kwargs then it will login to your device and does the `show running-con
 
 **if you select `json=True` then the object will return the result in json format. else, it would return as list of objects.**
 
-## Install the package
-
-https://pypi.org/project/cisco-config-parser/
-
-```ruby
-pip install cisco-config-parser
-```
-
 
 ## Regex Search Strings:
 

{cisco_config_parser-2.2 → cisco_config_parser-2.2.1}/README.md

@@ -1,8 +1,17 @@
 # Cisco Configuration Parser
-## This Package Will Parse Cisco IOS, IOS-XE, IOS-XR, and NXOS Configuration File.
 
+This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format
+
+##  New Version 2.0 
+
+## Install the package
+
+https://pypi.org/project/cisco-config-parser/
+
+```bash
+pip install cisco-config-parser
+```
 
-# New Version 2.0 
 
 ## Classes in this library
 
@@ -83,9 +92,6 @@ for i in eigrp:
 
 ```
 
-
-
-
 ### 1. Layer3 Interfaces:
 - added interface details - returns dict of all layer3 interfaces
 - methods are unified 
@@ -126,7 +132,7 @@ None
 <hr>
 <hr>
 
-# Old Version < 2.0  
+## Old Version < 2.0  
 
 There are two ways to parse the config, 1, SSH which is not recommended, and 2, feeding the running-config file 
 
@@ -159,14 +165,6 @@ pass the kwargs then it will login to your device and does the `show running-con
 
 **if you select `json=True` then the object will return the result in json format. else, it would return as list of objects.**
 
-## Install the package
-
-https://pypi.org/project/cisco-config-parser/
-
-```ruby
-pip install cisco-config-parser
-```
-
 
 ## Regex Search Strings:
 

cisco_config_parser-2.2.1/cisco_config_parser/helper/help.py

@@ -0,0 +1,122 @@
+
+
+RTP_IOS_HELP = """
+
+Example Usage:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+
+obj = ConfigParser(content)
+
+
+#
+##
+###
+#### Static Routes Example:
+###
+##
+#
+obj.get_static_routes()
+obj.get_static_routes(return_json=True)
+
+
+#
+##
+###
+#### OSPF Example:
+###
+##
+#
+ospf = obj.get_ospf_config(return_json=True)
+ospf = obj.get_ospf_config()
+for i in ospf:
+    print(i.children)
+    print(i.network)
+    print(i.no_passive_interface)
+
+#
+##
+###
+#### EIGRP Example:
+###
+##
+#
+eigrp = obj.get_eigrp_config(return_json=True)
+eigrp = obj.get_eigrp_config()
+for i in eigrp:
+    print(i.children)
+    print(i.network)
+    print(i.vrf_children) << returns a list of EIGRPVrfChildren objects
+    vrf_children = i.vrf_children
+    for vrf in vrf_children:
+        print(vrf.network)
+        print(vrf.children)
+"""
+PARENT_CHILD_HELP = """
+Example Usage:
+====================================================================================================
+
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+obj = ConfigParser(content)
+
+parent_child = obj.get_parent_child(custom_regex="(^snmp.*)|(^aaa.*)")
+
+for i in parent_child:
+    print(i.parent)
+    print(i.children)
+
+"""
+LAYER3_INTERFACE_HELP = """
+Example Usage:
+====================================================================================================
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+obj = ConfigParser(content)
+
+# returns dictionary of layer3 interfaces
+l3_intfs = obj.get_l3_interface_details()
+
+l3_intfs = obj.get_l3_interface()
+
+for intf in l3_intfs:
+    print(intf.name)
+    print(intf.ip_address)
+    print(intf.children)
+
+
+# you can also search for specific entry under layer3 interface with custom regex
+l3_intfs = obj.get_l3_interface(ip_pim="(ip\spim\s.*)", load_interval="(load\sinterval.*)")
+
+
+for intf in l3_intfs:
+    print(intf.name)
+    print(intf.ip_address)
+    print(intf.ip_pim) <<< dynamically creates an attribute based on the custom regex
+    print(intf.load_interval) <<< dynamically creates an attribute based on the custom regex
+
+"""
+
+LAYER2_INTERFACE_HELP = """
+Example Usage:
+====================================================================================================
+with open("show_run.txt", "r") as file_output:
+    content = file_output.read()
+
+obj = ConfigParser(content)
+
+# returns dictionary of layer2 interfaces
+l2_intfs = obj.get_l2_interface_details()
+
+l2_intfs = obj.get_l2_interface()
+
+for intf in l2_intfs:
+    print(intf.name)
+    print(intf.children)
+
+"""

{cisco_config_parser-2.2 → cisco_config_parser-2.2.1}/cisco_config_parser/helper/helper.py

@@ -14,9 +14,12 @@ class ParentChild:
 
 class L3Interface:
     def __repr__(self):
-        return "L3 Interface Usage"
+        return LAYER3_INTERFACE_HELP
 
 
+class L2Interface:
+    def __repr__(self):
+        return LAYER2_INTERFACE_HELP
 
 
 

{cisco_config_parser-2.2 → cisco_config_parser-2.2.1}/cisco_config_parser.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: cisco-config-parser
-Version: 2.2
-Summary: This Package Will Parse Cisco IOS, IOS-XE, IOS-XR and NXOS Configuration File.
+Version: 2.2.1
+Summary: This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format
 Home-page: https://github.com/arezazadeh/cisco_config_parser
 Author: Ahmad Rezazadeh
 Author-email: ahmad@klevernet.io
@@ -9,10 +9,19 @@ License: MIT License
 Description-Content-Type: text/markdown
 
 # Cisco Configuration Parser
-## This Package Will Parse Cisco IOS, IOS-XE, IOS-XR, and NXOS Configuration File.
 
+This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format
+
+##  New Version 2.0 
+
+## Install the package
+
+https://pypi.org/project/cisco-config-parser/
+
+```bash
+pip install cisco-config-parser
+```
 
-# New Version 2.0 
 
 ## Classes in this library
 
@@ -93,9 +102,6 @@ for i in eigrp:
 
 ```
 
-
-
-
 ### 1. Layer3 Interfaces:
 - added interface details - returns dict of all layer3 interfaces
 - methods are unified 
@@ -136,7 +142,7 @@ None
 <hr>
 <hr>
 
-# Old Version < 2.0  
+## Old Version < 2.0  
 
 There are two ways to parse the config, 1, SSH which is not recommended, and 2, feeding the running-config file 
 
@@ -169,14 +175,6 @@ pass the kwargs then it will login to your device and does the `show running-con
 
 **if you select `json=True` then the object will return the result in json format. else, it would return as list of objects.**
 
-## Install the package
-
-https://pypi.org/project/cisco-config-parser/
-
-```ruby
-pip install cisco-config-parser
-```
-
 
 ## Regex Search Strings:
 

{cisco_config_parser-2.2 → cisco_config_parser-2.2.1}/setup.py

@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
 
 HERE = pathlib.Path(__file__).parent
 
-VERSION = '2.2'
+VERSION = '2.2.1'
 PACKAGE_NAME = 'cisco_config_parser'
 AUTHOR = 'Ahmad Rezazadeh'
 AUTHOR_EMAIL = 'ahmad@klevernet.io'
@@ -11,7 +11,7 @@ AUTHOR_EMAIL = 'ahmad@klevernet.io'
 URL = 'https://github.com/arezazadeh/cisco_config_parser'
 
 LICENSE = 'MIT License'
-DESCRIPTION = 'This Package Will Parse Cisco IOS, IOS-XE, IOS-XR and NXOS Configuration File.'
+DESCRIPTION = 'This library is used for Network Automation involving Cisco Routers and Switch. It will parse Cisco IOS, IOS-XE, IOS-XR, and NXOS configuration file into objects and/or json format'
 LONG_DESCRIPTION = (HERE / "README.md").read_text()
 LONG_DESC_TYPE = "text/markdown"
 

cisco_config_parser-2.2/cisco_config_parser/helper/help.py

@@ -1,73 +0,0 @@
-
-
-RTP_IOS_HELP = """
-
-Example Usage:
-====================================================================================================
-
-with open("show_run.txt", "r") as file_output:
-    content = file_output.read()
-
-
-obj = ConfigParser(content)
-
-
-#
-##
-###
-#### Static Routes Example:
-###
-##
-#
-obj.get_static_routes()
-obj.get_static_routes(return_json=True)
-
-
-#
-##
-###
-#### OSPF Example:
-###
-##
-#
-ospf = obj.get_ospf_config(return_json=True)
-ospf = obj.get_ospf_config()
-for i in ospf:
-    print(i.children)
-    print(i.network)
-    print(i.no_passive_interface)
-
-#
-##
-###
-#### EIGRP Example:
-###
-##
-#
-eigrp = obj.get_eigrp_config(return_json=True)
-eigrp = obj.get_eigrp_config()
-for i in eigrp:
-    print(i.children)
-    print(i.network)
-    print(i.vrf_children) << returns a list of EIGRPVrfChildren objects
-    vrf_children = i.vrf_children
-    for vrf in vrf_children:
-        print(vrf.network)
-        print(vrf.children)
-"""
-PARENT_CHILD_HELP = """
-Example Usage:
-====================================================================================================
-
-with open("show_run.txt", "r") as file_output:
-    content = file_output.read()
-
-obj = ConfigParser(content)
-
-parent_child = obj.get_parent_child(custom_regex="(^snmp.*)|(^aaa.*)")
-
-for i in parent_child:
-    print(i.parent)
-    print(i.children)
-
-"""