bump to 0.4.0

Author: dmulyalin

docs/contribute.md

@@ -35,12 +35,11 @@ Before you start, make sure to think of for each template:
 * `misc` category - miscellaneous templates for various use cases organized in folders, naming
   rule is - `{{ usecase folder }}/{{ template name }}.txt` - upper or lower case
 
-To prepare your working environment might need to install required packages using requirements 
-files located in TTP Templates repository e.g.:
+To prepare your working environment you will need to install the required packages. The project
+uses [Poetry](https://python-poetry.org/) for dependency management:
 
 ```bash
-python3 -m pip install -r requirements-dev.txt
-python3 -m pip install -r requirements-docs.txt
+poetry install
 ```
 
 To add new template or multiple templates follow these steps:
@@ -122,8 +121,9 @@ interface Loopback0
     assert res == expected_output
 ```
 
-That test can be placed inside `test_platform_cisco_ios.py` file and run using command:
+That test can be placed inside `test_platform_cisco_ios.py` file and run using the command:
 
 ```bash
-pytest -vv test_platform_cisco_ios::test_cisco_ios_show_run_pipe_section_interface
+cd test
+poetry run pytest -vv test_platform_cisco_ios.py::test_cisco_ios_show_run_pipe_section_interface
 ```

docs/index.md

@@ -1,7 +1,7 @@
 
 ---
 
-**Templates count: 61**
+**Templates count: 66**
 
 ---
 

docs/release_notes.md

@@ -1,215 +1,112 @@
 # Release Notes
 
-## v0.1.2
-
-### Minor Features
-
-- Added support for `get_template` method to source template by path like `ttp://path/to/template.txt`
-- Added `ttp_vars.py` to repository to store common TTP variables
-- Added `short_interface_names` dictionary in `ttp_vars.py` for `resuball` to normalize interface names to shorter version
-
-### New Templates
-
-- `misc/Netmiko/cisco.ios.arp.txt`
-- `misc/Netmiko/cisco.ios.cfg.ip.txt`
-- `misc/Netmiko/cisco.iosxr.arp.txt`
-- `misc/Netmiko/huawei.vrp.cfg.ip.txt`
-- `yang/openconfig-lldp_cisco_ios.txt`
-- `yang/openconfig-lldp_cisco_nxos.txt`
-- `yang/openconfig-lldp_cisco_xr.txt`
-- `misc/netmiko/cisco.iosxr.cfg.ip.txt`
-- `mis/platform/arista_eos_show_hostname.txt`
-
-### Changes
+## v0.4.0
 
 ### Bugs
 
-## v0.1.3
-
-### Bugs
-
-- Fixed TTP Templates docs example path formation, should be not `ttp://misc.Netmiko.cisco.ios.arp.txt` but `ttp://misc/Netmiko/cisco.ios.arp.txt`
-
-### New Templates
-
-- Added N2G templates
-
-## v0.2.0
+- **Bug 1** – `parse_output` now raises `ValueError` with a descriptive message
+  when called without any valid template-locating argument (previously the
+  `None` returned by `get_template` was silently forwarded to the TTP
+  constructor, causing confusing downstream errors).
+- **Bug 2** – Fixed path-traversal vulnerability (OWASP A01) in `get_template`.
+  The resolved template filename is now verified with `os.path.realpath` to
+  confirm it falls inside the package directory before the file is opened;
+  crafted paths such as `path="../../etc/passwd"` now raise `ValueError`.
+- **Bug 3** – Fixed `list_templates` crashing with `AttributeError` when a
+  template file is placed directly inside the `misc/` root directory (rather
+  than in a subdirectory). The leaf-assignment logic now checks whether the
+  target key already holds a dict; if it does, the files are stored under the
+  empty-string sub-key instead of overwriting the dict with a list.
+- **Bug 4** – `list_templates` now returns file lists in sorted alphabetical
+  order. Previously `os.walk` / `os.listdir` produced non-deterministic
+  ordering across operating systems and filesystems, making the output
+  unreliable for callers and difficult to test reliably.
+- **Bug 5** – Fixed prefix-ambiguity in `short_interface_names` (`ttp_vars.py`).
+  The `2GE` patterns `'^Tw'` and `'^Two'` were broad enough to also match
+  `TwoHundredGigabitEthernet*` (200GE) names because `2GE` appeared before
+  `200GE` in the dict. Negative look-ahead anchors
+  (`r'^Tw(?!entyFive|oHundred)'` and `r'^Two(?!Hundred)'`) were added so
+  only genuine 2GE interface names are matched.
 
 ### Changes
 
-- Moved to Poetry for dependency management
+- Python minimum version bumped to 3.10.
+- Improved logging throughout all public API functions.
+- Improved type hint annotations and converted docstrings to Google format.
+- Improved inline comments for clarity.
+
+## v0.3.2
 
 ### Templates
 
-Added templates:
+- Added `misc/Netbox` folder with templates for Junos, IOS-XR, and Arista devices configuration.
 
-- `ttp://platform/juniper_show_isis_database_verbose_pipe_no_more.txt`
-- `ttp://misc/N2G/cli_l2_data/juniper.txt`
-- `ttp://misc/N2G/cli_isis_data/juniper.txt`
-- `ttp://platform/arista_eos_show_hostname.txt`
+## v0.3.1
 
-Modified templates:
+### Templates
 
-- `ttp://platform/cisco_xr_show_isis_database_verbose.txt` updated produced data structure to key LSPs by hostnames
+- Added `ttp://misc/N2G/cli_ip_data/arista_eos.txt` template to parse Arista EOS IP details for N2G L3 diagrams.
 
 ## v0.3.0
 
 ### Features
 
-- Added `list_templates` method to list available templates
+- Added `list_templates` method to list available templates.
 
 ### Bugs
 
-- Fixed Cisco IOS `show running-configuration` to correct command: `show running-config`
-- Updated N2G IOS-XR `cli_ip_data` template to match `ipv4 address 1.1.1.1/32` like config
+- Fixed Cisco IOS `show running-configuration` to correct command: `show running-config`.
+- Updated N2G IOS-XR `cli_ip_data` template to match `ipv4 address 1.1.1.1/32` style config.
 
 ### Templates
 
-- Updated all N2G templates to have default input with required commands and platform attributes
-
-## v0.3.1
+- Updated all N2G templates to have default input with required commands and platform attributes.
 
-### Templates
+## v0.2.0
 
-- Added `ttp://misc/N2G/cli_ip_data/arista_eos.txt` template to parse Arista EOS IP details for N2G L3 diagrams
+### Changes
 
-## v0.3.2
+- Moved to Poetry for dependency management.
 
 ### Templates
 
-- Added `misc/Netbox` folder with templates for Junos, IOS-XR, and Arista devices configuration
-
-# v0.1.2
-
-# Minor FEATURES
-
-1. Added support for "get_template" method to source template by path like "ttp://path/to/template.txt"
-2. Added "ttp_vars.py" to repository to store common TTP variables
-3. Added "short_interface_names" dictionary in "ttp_vars.py" for "resuball" to normalize interface names to shorter version
-
-# NEW TEMPLATES
-
-1. misc/Netmiko/cisco.ios.arp.txt
-2. misc/Netmiko/cisco.ios.cfg.ip.txt
-3. misc/Netmiko/cisco.iosxr.arp.txt
-4. misc/Netmiko/huawei.vrp.cfg.ip.txt
-5. yang/openconfig-lldp_cisco_ios.txt
-6. yang/openconfig-lldp_cisco_nxos.txt
-7. yang/openconfig-lldp_cisco_xr.txt
-9. misc/netmiko/cisco.iosxr.cfg.ip.txt
-10. mis/platform/arista_eos_show_hostname.txt
-
-# CHANGES
-
-1. 
-
-# BUGS
-
-1.
-
----
-
-# v0.1.3
-
-
-# BUGS 
-
-1. Fixed TTP Templates docs example path formation, should be not "ttp://misc.Netmiko.cisco.ios.arp.txt" but ttp://misc/Netmiko/cisco.ios.arp.txt
-
-# NEW TEMPLATES
-
-1. Added N2G templates
-
----
-
-# v0.2.0
-
-
-# CHANGES
-
-1. Moved to Poetry for dependency management
-
-# TEMPLATES
-
-1. Added templates:
-
-- ttp://platform/juniper_show_isis_database_verbose_pipe_no_more.txt 
-- ttp://misc/N2G/cli_l2_data/juniper.txt
-- ttp://misc/N2G/cli_isis_data/juniper.txt
-- ttp://platform/arista_eos_show_hostname.txt
-
-2. Modified templates:
-
-- ttp://platform/cisco_xr_show_isis_database_verbose.txt - updated produced data structure to key LSPs by hostnames
-
----
-
-# v0.3.0
-
-
-# FEATURES
-
-1. Added "list_templates" method to list available templates
-
-# BUGS
-
-1. Fixed Cisco IOS "show running-configuration" to correct command - "show running-config"
-2. Updated N2G ios-xr cli_ip_data template to match "ipv4 address 1.1.1.1/32" like config
-
-# TEMPLATES
-
-1. Updated all N2G Templates to have default input with required commands and platform attributes
-
----
-
-# v0.3.1
-
+Added templates:
 
-# TEMPLATES
+- `ttp://platform/juniper_junos_show_isis_database_verbose_pipe_no_more.txt`
+- `ttp://misc/N2G/cli_l2_data/juniper.txt`
+- `ttp://misc/N2G/cli_isis_data/juniper.txt`
+- `ttp://platform/arista_eos_show_hostname.txt`
 
-1. Added ttp://misc/N2G/cli_ip_data/arista_eos.txt template to parse Arista EOS IP details for N2G L3 diagrams
+Modified templates:
 
----
+- `ttp://platform/cisco_xr_show_isis_database_verbose.txt` – updated produced data structure to key LSPs by hostname.
 
-# v0.3.2
+## v0.1.3
 
+### Bugs
 
-# TEMPLATES
+- Fixed TTP Templates docs example path formation: the correct path is `ttp://misc/Netmiko/cisco.ios.arp.txt`, not `ttp://misc.Netmiko.cisco.ios.arp.txt`.
 
-1. Added misc/Netbox folder with templates for Junos, IOS-XR and Arista devices configuration
+### New Templates
 
----
+- Added N2G templates.
 
-# v0.4.0
+## v0.1.2
 
-## BUGS
+### Minor Features
 
-- **Bug 1** – `parse_output` now raises `ValueError` with a descriptive message
-  when called without any valid template-locating argument (previously the
-  `None` returned by `get_template` was silently forwarded to the TTP
-  constructor, causing confusing downstream errors).
-- **Bug 2** – Fixed path-traversal vulnerability (OWASP A01) in `get_template`.
-  The resolved template filename is now checked with `os.path.realpath` to
-  confirm it falls inside the package directory before the file is opened;
-  crafted paths such as `path="../../etc/passwd"` now raise `ValueError`.
-- **Bug 3** – Fixed `list_templates` crashing with `AttributeError` when a
-  template file is placed directly inside the `misc/` root directory (rather
-  than in a subdirectory).  The leaf-assignment logic now checks whether the
-  target key already holds a dict; if it does, files are stored under the
-  empty-string sub-key instead of overwriting the dict with a list.
-- **Bug 4** – `list_templates` now returns file lists in sorted alphabetical
-  order.  Previously `os.walk` / `os.listdir` produced non-deterministic
-  ordering across operating systems and filesystems, making the output
-  unreliable for callers and difficult to test.
-- **Bug 5** – Fixed prefix-ambiguity in `short_interface_names` (`ttp_vars.py`).
-  The `2GE` patterns ``'^Tw'`` and ``'^Two'`` were broad enough to also match
-  `TwoHundredGigabitEthernet*` (200GE) names because `2GE` appeared before
-  `200GE` in the dict. Negative look-ahead anchors
-  (``r'^Tw(?!entyFive|oHundred)'`` and ``r'^Two(?!Hundred)'``) were added so
-  only genuine 2GE interface names are matched.
+- Added support for `get_template` to source a template by path using the `ttp://` URI scheme.
+- Added `ttp_vars.py` to repository to store common TTP variables.
+- Added `short_interface_names` dictionary in `ttp_vars.py` for use with `resuball` to normalize interface names to shorter abbreviations.
 
-## CHANGES
+### New Templates
 
-1. Python minimum version bumped to 3.10
-2. Improving logging, type hints, commetns and converted docstrings to Google format
+- `misc/Netmiko/cisco.ios.arp.txt`
+- `misc/Netmiko/cisco.ios.cfg.ip.txt`
+- `misc/Netmiko/cisco.iosxr.arp.txt`
+- `misc/Netmiko/huawei.vrp.cfg.ip.txt`
+- `yang/openconfig-lldp_cisco_ios.txt`
+- `yang/openconfig-lldp_cisco_nxos.txt`
+- `yang/openconfig-lldp_cisco_xr.txt`
+- `misc/Netmiko/cisco.iosxr.cfg.ip.txt`
+- `platform/arista_eos_show_hostname.txt`